Flutter壁纸设置插件 flutter_wallpaper 的使用

flutter_wallpaper 是一个用于管理设备壁纸的Flutter插件。它提供了一种简单且高效的方式来下载、清除和获取有关设备壁纸的信息，并支持为设备的主屏幕、锁屏或两者设置壁纸。

功能特性

• 从URL设置壁纸：从URL下载图片并将其设置为壁纸。
• 下载壁纸：从URL下载图片并保存到设备相册。
• 清除壁纸：移除当前设备壁纸。
• 获取壁纸尺寸：从URL中获取图片的高度和宽度。
• 获取壁纸大小：从URL中获取图片文件大小。
• 支持主屏幕、锁屏或两者：允许将壁纸设置为主屏幕、锁屏或两者。

安装

在 pubspec.yaml 文件中添加 flutter_wallpaper 作为依赖项：

dependencies:
  flutter:
    sdk: flutter
  flutter_wallpaper: ^0.0.5

然后，在终端中运行 flutter pub get。

使用方法

初始化

无需初始化。

设置壁纸

从URL设置壁纸

import 'package:flutter_wallpaper/flutter_wallpaper.dart';

void setWallpaperFromUrl() async {
  String imageUrl = 'https://raw.githubusercontent.com/AKB0N/Mo-Salah-Wallpapers/refs/heads/master/pixel/1.png'; // 替换为你的图片URL
  int wallpaperLocation = WallpaperManager.bothScreen; // 可以选择 homeScreen, lockScreen 或 bothScreen

  await WallpaperManager.setWallpaper(imageUrl, wallpaperLocation);
}

下载壁纸

import 'package:flutter_wallpaper/flutter_wallpaper.dart';

void downloadWallpaper() async {
  String imageUrl = 'https://raw.githubusercontent.com/AKB0N/Mo-Salah-Wallpapers/refs/heads/master/pixel/1.png'; // 替换为你的图片URL
  String imageName = 'my_wallpaper.jpg'; // 期望的文件名
  int quality = 100; // 图片质量 (0-100)

  await WallpaperManager.downloadWallpaper(imageUrl, imageName, quality);
}

清除壁纸

import 'package:flutter_wallpaper/flutter_wallpaper.dart';

void clearWallpaper() async {
  bool success = await WallpaperManager.clearWallpaper();

  if(success) {
    print('Wallpaper cleared successfully!');
  } else {
    print('Failed to clear wallpaper.');
  }
}

获取壁纸信息

获取高度

import 'package:flutter_wallpaper/flutter_wallpaper.dart';

void getWallpaperHeight() async {
  String imageUrl = 'https://raw.githubusercontent.com/AKB0N/Mo-Salah-Wallpapers/refs/heads/master/pixel/1.png'; // 替换为你的图片URL
  int? height = await WallpaperManager.getWallpaperHeight(imageUrl);

  if(height != null) {
    print('Wallpaper height: $height');
  } else {
    print('Failed to get wallpaper height.');
  }
}

获取宽度

import 'package:flutter_wallpaper/flutter_wallpaper.dart';

void getWallpaperWidth() async {
  String imageUrl = 'https://raw.githubusercontent.com/AKB0N/Mo-Salah-Wallpapers/refs/heads/master/pixel/1.png'; // 替换为你的图片URL
  int? width = await WallpaperManager.getWallpaperWidth(imageUrl);

  if(width != null) {
     print('Wallpaper width: $width');
  } else {
     print('Failed to get wallpaper width.');
  }
}

获取大小

import 'package:flutter_wallpaper/flutter_wallpaper.dart';

void getWallpaperSize() async {
  String imageUrl = 'https://raw.githubusercontent.com/AKB0N/Mo-Salah-Wallpapers/refs/heads/master/pixel/1.png'; // 替换为你的图片URL
  String? size = await WallpaperManager.getWallpaperSize(imageUrl);

  if (size != null) {
    print('Wallpaper size: $size');
  } else {
    print('Failed to get wallpaper size.');
  }
}

常量

以下常量在 WallpaperManager 类中可用：

• WallpaperManager.homeScreen：表示主屏幕壁纸位置。
• WallpaperManager.lockScreen：表示锁屏壁纸位置。
• WallpaperManager.bothScreen：表示主屏幕和锁屏壁纸位置。

权限

Android

• <uses-permission android:name="android.permission.SET_WALLPAPER"/>（用于设置壁纸）
• <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" android:maxSdkVersion="29"/>（用于下载图片）

iOS

由于Apple的安全限制，程序化设置iOS上的壁纸是不支持的。此插件无法更改主屏幕或锁屏壁纸。但是，下载并保存壁纸到照片库是完全支持的。

需要在 ios/Runner/Info.plist 中添加权限：

<key>NSPhotoLibraryAddUsageDescription</key>
<string>This app requires photo library access to save the wallpaper.</string>

示例Demo

以下是完整的示例代码，展示如何在Flutter应用中使用 flutter_wallpaper 插件：

import 'package:flutter/material.dart';
import 'dart:async';
import 'package:flutter/services.dart';
import 'package:flutter_wallpaper/flutter_wallpaper.dart';

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

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

  @override
  MyAppState createState() => MyAppState();
}

class MyAppState extends State<MyApp> {
  String _platformVersion = 'Unknown';
  String __heightWidth = 'Unknown';
  String __size = 'Unknown';
  String imageURL =
      'https://raw.githubusercontent.com/AKB0N/Mo-Salah-Wallpapers/refs/heads/master/pixel/1.png';

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

  void clearWallpaper() async {
    bool success = await WallpaperManager.clearWallpaper();

    if (success) {
      debugPrint('Wallpaper cleared successfully!');
    } else {
      debugPrint('Failed to clear wallpaper.');
    }
  }

  Future<void> initAppState() async {
    String platformVersion;
    String heightWidth;
    String size;

    try {
      platformVersion =
          await WallpaperManager.platformVersion ?? 'Unknown platform version';
    } on PlatformException {
      platformVersion = 'Failed to get platform version.';
    }

    try {
      int getHeight = await WallpaperManager.getWallpaperHeight(imageURL);
      int getWidth = await WallpaperManager.getWallpaperWidth(imageURL);
      String getSize = await WallpaperManager.getWallpaperSize(imageURL);

      size = 'Size = $getSize';
      heightWidth = 'Width = $getWidth Height = $getHeight';
    } on PlatformException {
      size = 'Failed to get Size';
      heightWidth = 'Failed to get Height and Width';
    }

    if (!mounted) return;

    setState(() {
      __size = size;
      __heightWidth = heightWidth;
      _platformVersion = platformVersion;
    });
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Center(
            child: SingleChildScrollView(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            crossAxisAlignment: CrossAxisAlignment.center,
            children: [
              Image.network(imageURL),
              Text('Running on: $_platformVersion\n'),
              const SizedBox(
                height: 10,
              ),
              Text('$__heightWidth\n'),
              Text('$__size\n'),
              const SizedBox(
                height: 10,
              ),
              TextButton(
                  onPressed: () {
                    WallpaperManager.setWallpaper(
                      imageURL,
                      WallpaperManager.bothScreen,
                    );
                  },
                  child: const Text('Set Wallpaper')),
              TextButton(
                  onPressed: () {
                    WallpaperManager.downloadWallpaper(
                      imageURL,
                      'test',
                      100,
                    );
                  },
                  child: const Text('Download Wallpaper')),
              TextButton(
                  onPressed: () {
                    clearWallpaper();
                  },
                  child: const Text('Clear Wallpaper')),
              const SizedBox(
                height: 10,
              ),
            ],
          ),
        )),
      ),
    );
  }
}

通过上述代码，您可以轻松地在Flutter应用中实现壁纸设置、下载和清除功能。