WallpaperPluginPlatform class abstract

Platform interface for wallpaper_setter.

All wallpaper operations are routed through an instance of this interface, which allows the implementation to be swapped out (for example, in tests).

Inheritance
  • Object
  • PlatformInterface
  • WallpaperPluginPlatform
Implementers

Constructors

WallpaperPluginPlatform()

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

getCapabilities() Future<WallpaperCapabilities>
Returns the capabilities supported by the current platform.
getImageBytesFromUri(String uri) Future<Uint8List?>
Reads the encoded image bytes referenced by a content:// uri, or returns null if it cannot be read.
getScreenInfo() Future<WallpaperScreenInfo>
Returns basic screen / wallpaper information when reliably available.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setIncomingWallpaperHandler(IncomingWallpaperCallback? handler) → void
Registers a callback invoked when an external app (e.g. Photos/Gallery) hands this app an image via an Android ACTION_SET_WALLPAPER / ACTION_ATTACH_DATA intent carrying a content:// URI.
setWallpaperFromBytes(Uint8List bytes, WallpaperTarget target, {WallpaperFit? fit}) Future<WallpaperResult>
Sets the wallpaper from raw image bytes.
setWallpaperFromFile(File file, WallpaperTarget target, {WallpaperFit? fit}) Future<WallpaperResult>
Sets the wallpaper from an image file.
setWallpaperFromRepaintBoundary(GlobalKey<State<StatefulWidget>> boundaryKey, WallpaperTarget target, {double pixelRatio = 2.5, WallpaperFit? fit}) Future<WallpaperResult>
Sets the wallpaper from a RepaintBoundary identified by boundaryKey.
setWallpaperFromUri(String uri, WallpaperTarget target, {WallpaperFit? fit}) Future<WallpaperResult>
Sets the wallpaper from a content:// uri supplied by an external app.
setWallpaperFromUrl(String url, WallpaperTarget target, {WallpaperFit? fit}) Future<WallpaperResult>
Sets the wallpaper from a network url.
toString() String
A string representation of this object.
inherited
useAsImageFromRepaintBoundary(GlobalKey<State<StatefulWidget>> boundaryKey, {double pixelRatio = 2.5}) Future<WallpaperResult>
Shares / uses an image captured from a RepaintBoundary.

Operators

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

Static Properties

instance WallpaperPluginPlatform
getter/setter pair