FloatingWindowAndroid class

Floating Window Android Plugin

Constructors

FloatingWindowAndroid.new()

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

getPlatformVersion() Future<String?>
Get platform version
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Properties

overlayListener Stream
Get floating window event listener
no setter

Static Methods

cleanupPreloadedEngine() Future<bool>
Clean up preloaded Flutter engine to free memory Call this when the app is being destroyed or no longer needs overlay functionality
closeOverlay() Future<bool>
Close floating window
closeOverlayFromOverlay() Future<void>
Close floating window from within the floating window
getOverlayPosition() Future<OverlayPosition>
Get current floating window position
isFlutterEnginePreloaded() Future<bool>
Check if Flutter engine is preloaded and ready for fast overlay startup
isMainAppRunning() Future<bool>
Check if main app is running in foreground
isPermissionGranted() Future<bool>
Check if floating window permission is granted
isShowing() Future<bool>
Checks if the overlay window is currently being shown.
moveOverlay(OverlayPosition position) Future<bool>
Move floating window position
openMainApp([Map<String, dynamic>? params]) Future<bool>
Open main app from floating window
preloadFlutterEngine({String dartEntryPoint = "overlayMain"}) Future<bool>
Preload Flutter engine for faster overlay startup Call this method during app initialization to warm up the engine dartEntryPoint - The Dart entry point for the overlay (default: "overlayMain")
requestPermission() Future<bool>
Request floating window permission
resizeOverlay(int width, int height) Future<bool>
Resize floating window
shareData(dynamic data) Future<bool>
Share data between floating window and main app
showOverlay({int height = WindowSize.fullCover, int width = WindowSize.matchParent, String alignment = OverlayAlignment.center, String notificationVisibility = NotificationVisibility.visibilitySecret, OverlayFlag flag = OverlayFlag.defaultFlag, String overlayTitle = "Floating Window Activated", String? overlayContent, bool enableDrag = false, PositionGravity positionGravity = PositionGravity.none, OverlayPosition? startPosition}) Future<bool>
Show floating window
updateFlag(OverlayFlag flag) Future<bool>
Update floating window flag