Package selection guidance compiled from public package information, community data, and project usage.
Wallpaper Manager is a Flutter plugin that enables developers to programmatically set the home screen, lock screen, or both wallpapers on Android devices. It provides a simple interface to apply images as wallpapers directly from within a Flutter app, enhancing user experience in photo or customization apps. The plugin leverages native Android APIs and currently supports Android only, with no iOS implementation. It requires appropriate permissions and works best when integrated into apps focused on personalization, image galleries, or digital art displays.
Use cases
Setting dynamic wallpapers from app content
Creating photo gallery apps with wallpaper features
Enabling user customization in lifestyle apps
Integrating wallpaper changes in digital art platforms
Key features
Set home screen wallpaper
Set lock screen wallpaper
Support for both screens simultaneously
Simple API integration with Flutter
Uses native Android wallpaper APIs
Suitable for
Android-only apps requiring wallpaper changes
Photo and art sharing applications
User personalization tools
Apps with dynamic background themes
Considerations
Only available for Android devices
Requires runtime permission request
Limited to Android's wallpaper system
Does not support iOS
May require handling of image resolution and format
Original README
Original README snapshot from the linked source repository. Visit the repository for the latest content.
wallpaper_manager
A Flutter plugin for changing the Home Screen, Lock Screen (or both) Wallpaper(s) on Android devices.
Usage
Installation
In the pubspec.yaml of your flutter project, add the following dependency:
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.