FlutterOverlayWindow class

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

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

Streams message shared between overlay and main app

no setter

Static Methods

closeOverlay() → Future<bool?>

Closes overlay if open

disposeOverlayListener() → void

Dispose overlay stream

getOverlayPosition() → Future<OverlayPosition>

Get the current overlay position

isActive() → Future<bool>

Check if the current overlay is active

isPermissionGranted() → Future<bool>

Check if overlay permission is granted

moveOverlay(OverlayPosition position) → Future<bool?>

Update the overlay position in the screen

requestPermission() → Future<bool?>

Request overlay permission it will open the overlay settings page and return true once the permission granted.

resizeOverlay(int width, int height, bool enableDrag) → Future<bool?>

Update the overlay size in the screen

screenShot(OverlayFlag flag) → Future<String?>

shareData(dynamic data) → Future

Broadcast data to and from overlay app

showOverlay({int height = WindowSize.fullCover, int width = WindowSize.matchParent, OverlayAlignment alignment = OverlayAlignment.center, NotificationVisibility visibility = NotificationVisibility.visibilitySecret, OverlayFlag flag = OverlayFlag.defaultFlag, String overlayTitle = "overlay activated", String? overlayContent, bool enableDrag = false, PositionGravity positionGravity = PositionGravity.none, OverlayPosition? startPosition}) → Future<void>

Open overLay content

updateFlag(OverlayFlag flag) → Future<bool?>

Update the overlay flag while the overlay in action