Since this is not a Widget, you have to create WallpaperManager constructors from inside an async function, which is a Future that returns a String output specifying success/failure.
String path = "/path/to/file/on/disk";
int location = WallpaperManager.HOME_SCREEN; // or location = WallpaperManager.LOCK_SCREEN;finalString result = awaitWallpaperManager.setWallpaperFromFile(path, location);
Basic Usage with error handling
You might want to wrap it in a try/catch since platform messages (plug-ins like these) may fail
String path = "/path/to/file/on/disk";
int location = WallpaperManager.HOME_SCREEN; // or location = WallpaperManager.LOCK_SCREEN;String result;
try {
result = awaitWallpaperManager.setWallpaperFromFile(path, location);
} onPlatformException {
result = 'Failed to get wallpaper.';
}
Loading from a URL (with CacheManager, the image is saved to app files as well)
If you're loading a Wallpaper from a URL, you should save it to the disk first, then use the path of the saved image file.
Add flutter_cache_manager or any other dependency you'd like:
dependencies:...flutter_cache_manager:"^1.1.3"
And in dart code
String url = "";
int location = WallpaperManager.HOME_SCREEN; // or location = WallpaperManager.LOCK_SCREEN;String result;
var file = awaitDefaultCacheManager().getSingleFile(url);
finalString result = awaitWallpaperManager.setWallpaperFromFile(file.path, location);
Loading from a Flutter asset
If you're loading a Wallpaper from an asset, you need to make sure it is indexed in the pubspec.yaml file first
String assetPath = "assets/tmp1.jpg";
int location = WallpaperManager.HOME_SCREEN; // or location = WallpaperManager.LOCK_SCREEN;String result;
finalString result = awaitWallpaperManager.setWallpaperFromAsset(assetPath, location);
Getting started
With Wallpaper Manager
See the example directory for a complete sample app using Wallpaper Manager.
With Flutter
For help getting started with Flutter, view the online documentation.
Notes
iOS does not support changing Wallpapers from third-party apps (Source)
Xiaomi/MIUI does not support changing Lock Screen Wallpapers directly from the Android API (Source). You might want to look at creating a Lock Screen Launcher app instead.
[x] Add rect values for optionally cropping the image
[ ] Add variable for re-using Wallpaper from phone's settings
[ ] Write more tests
Changelog
Please see the Changelog page to know what's recently changed.
Contributions
Feel free to contribute to this project.
If you find a bug or want a feature, but don't know how to fix/implement it, please fill an issue.
If you fixed a bug or implemented a feature, please send a pull request.