device_wallpaper_flutter #

A Flutter plugin to get device wallpaper, supporting static and live wallpapers on Android.

Features #

✅ Get device wallpaper as Uint8List bytes
✅ Support for static wallpapers
✅ Support for live wallpapers (returns thumbnail)
✅ Android platform support
✅ Easy to use API
✅ Example app included

Supported Platforms #

Android

Installation #

Add device_wallpaper_flutter to your pubspec.yaml file:

dependencies:
  flutter:
    sdk: flutter
  device_wallpaper_flutter: ^1.0.1

Then run flutter pub get to install the plugin.

Usage #

Basic Usage #

import 'package:flutter/material.dart';
import 'package:device_wallpaper_flutter/device_wallpaper_flutter.dart';
import 'dart:typed_data';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  Uint8List? _wallpaper;
  String _error = '';

  @override
  void initState() {
    super.initState();
    loadWallpaper();
  }

  Future<void> loadWallpaper() async {
    try {
      final bytes = await DeviceWallpaperFlutter.getWallpaper();
      setState(() {
        _wallpaper = bytes;
        _error = '';
      });
    } on PlatformException {
      setState(() {
        _error = 'Failed to load wallpaper.';
      });
    }
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Wallpaper Plugin Example'),
        ),
        body: Center(
          child: _error.isNotEmpty
              ? Text(_error)
              : _wallpaper == null
                  ? const CircularProgressIndicator()
                  : Image.memory(_wallpaper!),
        ),
        floatingActionButton: FloatingActionButton(
          onPressed: loadWallpaper,
          tooltip: 'Refresh Wallpaper',
          child: const Icon(Icons.refresh),
        ),
      ),
    );
  }
}

Permission Handling #

On Android, you need to request permissions to access media files. For Android 13+ (API 33+), use READ_MEDIA_IMAGES permission. For older versions, use READ_EXTERNAL_STORAGE permission.

Add the following to your AndroidManifest.xml:

<uses-permission android:name="android.permission.READ_MEDIA_IMAGES" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" android:maxSdkVersion="32" />

You can use the permission_handler package to request permissions at runtime.

API Reference #