feat: get/start overlay from specific position

Author: X-SLAYER

README.md

@@ -24,10 +24,12 @@
 Flutter plugin for displaying your Flutter app over other apps on the screen
 </p>
 
+---
+
 ## Preview
 
-|TrueCaller overlay example|click-through overlay example|  Messanger chat-head example |
-| :-:| :-: | :-: |
+|                                                          TrueCaller overlay example                                                          |                                                        click-through overlay example                                                        |                                                         Messanger chat-head example                                                         |
+| :------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------: |
 | <img src='https://user-images.githubusercontent.com/22800380/165636217-8957396b-dc54-4e6d-aa50-e8bfdb9383cf.gif' height='600' width='300' /> | <img src='https://user-images.githubusercontent.com/22800380/165636120-dcd9ee13-5fca-4f8a-a562-b2f53c0b5e24.gif' height='600' width='300'/> | <img src='https://user-images.githubusercontent.com/22800380/178730917-40f267bb-63a2-4ad3-ba69-f7c1285a1882.gif' height='600' width='300'/> |
 
 ## Installation
@@ -79,17 +81,29 @@ void overlayMain() {
  /// it will open the overlay settings page and return `true` once the permission granted.
  final bool status = await FlutterOverlayWindow.requestPermission();
 
- /// Open overLay content
- ///
- /// - Optional arguments:
- /// `height` the overlay height and default is [overlaySizeFill]
- /// `width` the overlay width and default is [overlaySizeFill]
- /// `OverlayAlignment` the alignment postion on screen and default is [OverlayAlignment.center]
- /// `OverlayFlag` the overlay flag and default is [OverlayFlag.defaultFlag]
- /// `overlayTitle` the notification message and default is "overlay activated"
- /// `overlayContent` the notification message
- /// `enableDrag` to enable/disable dragging the overlay over the screen and default is "false"
- /// `positionGravity` the overlay postion after drag and default is [PositionGravity.none]
+  /// Open overLay content
+  ///
+  /// - Optional arguments:
+  ///
+  /// `height` the overlay height and default is [WindowSize.fullCover]
+  ///
+  /// `width` the overlay width and default is [WindowSize.matchParent]
+  ///
+  /// `alignment` the alignment postion on screen and default is [OverlayAlignment.center]
+  ///
+  /// `visibilitySecret` the detail displayed in notifications on the lock screen and default is [NotificationVisibility.visibilitySecret]
+  ///
+  /// `OverlayFlag` the overlay flag and default is [OverlayFlag.defaultFlag]
+  ///
+  /// `overlayTitle` the notification message and default is "overlay activated"
+  ///
+  /// `overlayContent` the notification message
+  ///
+  /// `enableDrag` to enable/disable dragging the overlay over the screen and default is "false"
+  ///
+  /// `positionGravity` the overlay postion after drag and default is [PositionGravity.none]
+  ///
+  /// `startPosition` the overlay start position and default is null
  await FlutterOverlayWindow.showOverlay();
 
  /// closes overlay if open
@@ -113,6 +127,18 @@ void overlayMain() {
  /// Update the overlay size in the screen
  await FlutterOverlayWindow.resizeOverlay(80, 120);
 
+ /// Update the overlay position in the screen
+ ///
+ /// `position` the new position of the overlay
+ ///
+ /// `return` true if the position updated successfully
+ await FlutterOverlayWindow.moveOverlay(OverlayPosition(0, 156))
+
+ /// Get the current overlay position
+ ///
+ /// `return` the current overlay position
+ await FlutterOverlayWindow.getOverlayPosition()
+
 ```
 
 ```dart

android/src/main/java/flutter/overlay/window/flutter_overlay_window/FlutterOverlayWindowPlugin.java

@@ -9,11 +9,15 @@
 import android.provider.Settings;
 import android.service.notification.StatusBarNotification;
 import android.util.Log;
+import android.view.WindowManager;
 
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
+import androidx.annotation.RequiresApi;
 import androidx.core.app.NotificationManagerCompat;
 
+import java.util.Map;
+
 import io.flutter.FlutterInjector;
 import io.flutter.embedding.engine.FlutterEngine;
 import io.flutter.embedding.engine.FlutterEngineCache;
@@ -55,6 +59,7 @@ public void onAttachedToEngine(@NonNull FlutterPluginBinding flutterPluginBindin
         WindowSetup.messenger.setMessageHandler(this);
     }
 
+    @RequiresApi(api = Build.VERSION_CODES.N)
     @Override
     public void onMethodCall(@NonNull MethodCall call, @NonNull Result result) {
         pendingResult = result;
@@ -82,6 +87,10 @@ public void onMethodCall(@NonNull MethodCall call, @NonNull Result result) {
             String notificationVisibility = call.argument("notificationVisibility");
             boolean enableDrag = call.argument("enableDrag");
             String positionGravity = call.argument("positionGravity");
+            Map<String, Integer> startPosition = call.argument("startPosition");
+            int startX = startPosition != null ? startPosition.getOrDefault("x", OverlayConstants.DEFAULT_XY) : OverlayConstants.DEFAULT_XY;
+            int startY = startPosition != null ? startPosition.getOrDefault("y", OverlayConstants.DEFAULT_XY) : OverlayConstants.DEFAULT_XY;
+
 
             WindowSetup.width = width != null ? width : -1;
             WindowSetup.height = height != null ? height : -1;
@@ -96,11 +105,22 @@ public void onMethodCall(@NonNull MethodCall call, @NonNull Result result) {
             final Intent intent = new Intent(context, OverlayService.class);
             intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
             intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
+            intent.putExtra("startX", startX);
+            intent.putExtra("startY", startY);
             context.startService(intent);
             result.success(null);
         } else if (call.method.equals("isOverlayActive")) {
             result.success(OverlayService.isRunning);
             return;
+        } else if (call.method.equals("isOverlayActive")) {
+            result.success(OverlayService.isRunning);
+            return;
+        } else if (call.method.equals("moveOverlay")) {
+            int x = call.argument("x");
+            int y = call.argument("y");
+            result.success(OverlayService.moveOverlay(x, y));
+        } else if (call.method.equals("getOverlayPosition")) {
+            result.success(OverlayService.getCurrentPosition());
         } else if (call.method.equals("closeOverlay")) {
             if (OverlayService.isRunning) {
                 final Intent i = new Intent(context, OverlayService.class);

android/src/main/java/flutter/overlay/window/flutter_overlay_window/OverlayConstants.java

@@ -8,4 +8,5 @@ final public class OverlayConstants {
     static final String MESSENGER_TAG = "x-slayer/overlay_messenger";
     static final String CHANNEL_ID = "Overlay Channel";
     static final int NOTIFICATION_ID = 4579;
+    static final int DEFAULT_XY = -6;
 }

android/src/main/java/flutter/overlay/window/flutter_overlay_window/OverlayService.java

@@ -30,6 +30,8 @@
 
 import com.example.flutter_overlay_window.R;
 
+import java.util.HashMap;
+import java.util.Map;
 import java.util.Timer;
 import java.util.TimerTask;
 
@@ -50,6 +52,8 @@ public class OverlayService extends Service implements View.OnTouchListener {
     private Resources mResources;
 
     public static final String INTENT_EXTRA_IS_CLOSE_WINDOW = "IsCloseWindow";
+
+    private static OverlayService instance;
     public static boolean isRunning = false;
     private WindowManager windowManager = null;
     private FlutterView flutterView;
@@ -86,12 +90,15 @@ public void onDestroy() {
         isRunning = false;
         NotificationManager notificationManager = (NotificationManager) getApplicationContext().getSystemService(Context.NOTIFICATION_SERVICE);
         notificationManager.cancel(OverlayConstants.NOTIFICATION_ID);
+        instance = null;
     }
 
     @RequiresApi(api = Build.VERSION_CODES.JELLY_BEAN_MR1)
     @Override
     public int onStartCommand(Intent intent, int flags, int startId) {
         mResources = getApplicationContext().getResources();
+        int startX = intent.getIntExtra("startX", OverlayConstants.DEFAULT_XY);
+        int startY = intent.getIntExtra("startY", OverlayConstants.DEFAULT_XY);
         boolean isCloseWindow = intent.getBooleanExtra(INTENT_EXTRA_IS_CLOSE_WINDOW, false);
         if (isCloseWindow) {
             if (windowManager != null) {
@@ -123,6 +130,10 @@ public int onStartCommand(Intent intent, int flags, int startId) {
             if (call.method.equals("updateFlag")) {
                 String flag = call.argument("flag").toString();
                 updateOverlayFlag(result, flag);
+            } else if (call.method.equals("updateOverlayPosition")) {
+                int x = call.<Integer>argument("x");
+                int y = call.<Integer>argument("y");
+                moveOverlay(x, y, result);
             } else if (call.method.equals("resizeOverlay")) {
                 int width = call.argument("width");
                 int height = call.argument("height");
@@ -144,6 +155,8 @@ public int onStartCommand(Intent intent, int flags, int startId) {
             int h = displaymetrics.heightPixels;
             szWindow.set(w, h);
         }
+        int dx = startX == OverlayConstants.DEFAULT_XY ? 0 : startX;
+        int dy = startY == OverlayConstants.DEFAULT_XY ? -statusBarHeightPx() : startY;
         WindowManager.LayoutParams params = new WindowManager.LayoutParams(
                 WindowSetup.width == -1999 ? -1 : WindowSetup.width,
                 WindowSetup.height != -1999 ? WindowSetup.height : screenHeight(),
@@ -162,6 +175,7 @@ public int onStartCommand(Intent intent, int flags, int startId) {
         params.gravity = WindowSetup.gravity;
         flutterView.setOnTouchListener(this);
         windowManager.addView(flutterView, params);
+        moveOverlay(dx, dy, null);
         return START_STICKY;
     }
 
@@ -238,6 +252,48 @@ private void resizeOverlay(int width, int height, boolean enableDrag, MethodChan
         }
     }
 
+    private void moveOverlay(int x, int y, MethodChannel.Result result) {
+        if (windowManager != null) {
+            WindowManager.LayoutParams params = (WindowManager.LayoutParams) flutterView.getLayoutParams();
+            params.x = (x == -1999 || x == -1) ? -1 : dpToPx(x);
+            params.y = dpToPx(y);
+            windowManager.updateViewLayout(flutterView, params);
+            if (result != null)
+                result.success(true);
+        } else {
+            if (result != null)
+                result.success(false);
+        }
+    }
+
+
+    public static Map<String, Double> getCurrentPosition() {
+        if (instance != null && instance.flutterView != null) {
+            WindowManager.LayoutParams params = (WindowManager.LayoutParams) instance.flutterView.getLayoutParams();
+            Map<String, Double> position = new HashMap<>();
+            position.put("x", instance.pxToDp(params.x));
+            position.put("y", instance.pxToDp(params.y));
+            return position;
+        }
+        return null;
+    }
+
+    public static boolean moveOverlay(int x, int y) {
+        if (instance != null && instance.flutterView != null) {
+            if (instance.windowManager != null) {
+                WindowManager.LayoutParams params = (WindowManager.LayoutParams) instance.flutterView.getLayoutParams();
+                params.x = (x == -1999 || x == -1) ? -1 : instance.dpToPx(x);
+                params.y = instance.dpToPx(y);
+                instance.windowManager.updateViewLayout(instance.flutterView, params);
+                return true;
+            } else {
+                return false;
+            }
+        } else {
+            return false;
+        }
+    }
+
 
     @Override
     public void onCreate() {
@@ -260,6 +316,7 @@ public void onCreate() {
                 .setVisibility(WindowSetup.notificationVisibility)
                 .build();
         startForeground(OverlayConstants.NOTIFICATION_ID, notification);
+        instance = this;
     }
 
     private void createNotificationChannel() {
@@ -284,6 +341,10 @@ private int dpToPx(int dp) {
                 Float.parseFloat(dp + ""), mResources.getDisplayMetrics());
     }
 
+    private double pxToDp(int px) {
+        return (double) px / mResources.getDisplayMetrics().density;
+    }
+
     private boolean inPortrait() {
         return mResources.getConfiguration().orientation == Configuration.ORIENTATION_PORTRAIT;
     }

android/src/main/java/flutter/overlay/window/flutter_overlay_window/WindowSetup.java

@@ -47,6 +47,19 @@ static void setFlag(String name) {
         }
     }
 
+    static void showWhenLocked(String name) {
+        if (name.equalsIgnoreCase("flagNotFocusable") || name.equalsIgnoreCase("defaultFlag")) {
+            flag = WindowManager.LayoutParams.FLAG_NOT_FOCUSABLE;
+        }
+        if (name.equalsIgnoreCase("flagNotTouchable") || name.equalsIgnoreCase("clickThrough")) {
+            flag = WindowManager.LayoutParams.FLAG_NOT_TOUCHABLE | WindowManager.LayoutParams.FLAG_NOT_FOCUSABLE |
+                    WindowManager.LayoutParams.FLAG_LAYOUT_NO_LIMITS | WindowManager.LayoutParams.FLAG_LAYOUT_IN_SCREEN;
+        }
+        if (name.equalsIgnoreCase("flagNotTouchModal") || name.equalsIgnoreCase("focusPointer")) {
+            flag = WindowManager.LayoutParams.FLAG_NOT_TOUCH_MODAL;
+        }
+    }
+
     static void setGravityFromAlignment(String alignment) {
         if (alignment.equalsIgnoreCase("topLeft")) {
             gravity = Gravity.TOP | Gravity.LEFT;

example/lib/home_page.dart

@@ -74,6 +74,7 @@ class _HomePageState extends State<HomePage> {
                   positionGravity: PositionGravity.auto,
                   height: (MediaQuery.of(context).size.height * 0.6).toInt(),
                   width: WindowSize.matchParent,
+                  startPosition: const OverlayPosition(0, -259),
                 );
               },
               child: const Text("Show Overlay"),
@@ -115,6 +116,27 @@ class _HomePageState extends State<HomePage> {
               },
               child: const Text("Send message to overlay"),
             ),
+            const SizedBox(height: 20.0),
+            TextButton(
+              onPressed: () {
+                FlutterOverlayWindow.getOverlayPosition().then((value) {
+                  log('Overlay Position: $value');
+                  setState(() {
+                    latestMessageFromOverlay = 'Overlay Position: $value';
+                  });
+                });
+              },
+              child: const Text("Get overlay position"),
+            ),
+            const SizedBox(height: 20.0),
+            TextButton(
+              onPressed: () {
+                FlutterOverlayWindow.moveOverlay(
+                  const OverlayPosition(0, 0),
+                );
+              },
+              child: const Text("Move overlay position to (0, 0)"),
+            ),
             const SizedBox(height: 20),
             Text(latestMessageFromOverlay ?? ''),
           ],

example/lib/overlays/true_caller_overlay.dart

@@ -29,12 +29,6 @@ class _TrueCallerOverlayState extends State<TrueCallerOverlay> {
   @override
   void initState() {
     super.initState();
-    FlutterOverlayWindow.overlayListener.listen((event) {
-      log("$event");
-      setState(() {
-        isGold = !isGold;
-      });
-    });
   }
 
   @override
@@ -55,8 +49,12 @@ class _TrueCallerOverlayState extends State<TrueCallerOverlay> {
           ),
           child: GestureDetector(
             onTap: () {
-              FlutterOverlayWindow.shareData(
-                  "Heyy this is a data from the overlay");
+              setState(() {
+                isGold = !isGold;
+              });
+              FlutterOverlayWindow.getOverlayPosition().then((value) {
+                log("Overlay Position: $value");
+              });
             },
             child: Stack(
               children: [

lib/flutter_overlay_window.dart

@@ -2,3 +2,4 @@ library flutter_overlay_window;
 
 export 'package:flutter_overlay_window/src/overlay_window.dart';
 export 'package:flutter_overlay_window/src/overlay_config.dart';
+export 'package:flutter_overlay_window/src/models/overlay_position.dart';

lib/src/models/overlay_position.dart

@@ -0,0 +1,20 @@
+import 'package:flutter/foundation.dart';
+
+@immutable
+class OverlayPosition {
+  final double x;
+  final double y;
+
+  const OverlayPosition(this.x, this.y);
+
+  factory OverlayPosition.fromMap(Map<Object?, Object?>? map) =>
+      OverlayPosition(map?['x'] as double? ?? 0, map?['y'] as double? ?? 0);
+
+  Map<String, dynamic> toMap() =>
+      <String, dynamic>{'x': x.toInt(), 'y': y.toInt()};
+
+  @override
+  String toString() {
+    return 'OverlayPosition{x=$x, y=$y}';
+  }
+}