Flutter壁纸管理插件wallpaper_manager的使用

wallpaper_manager

一个用于在Android设备上更改主屏幕、锁屏（或两者）壁纸的Flutter插件。

使用方法

安装

在Flutter项目的pubspec.yaml文件中添加以下依赖：

dependencies:
  ...
  wallpaper_manager: "^1.0.10"

在您的库中添加以下导入：

import 'package:wallpaper_manager/wallpaper_manager.dart';

示例

基本用法

由于这不是一个Widget，您必须在一个异步函数内部创建WallpaperManager构造函数，该函数是一个返回字符串输出（指定成功/失败）的Future。

String path = "/path/to/file/on/disk";
int location = WallpaperManager.HOME_SCREEN; // 或 location = WallpaperManager.LOCK_SCREEN;
final String result = await WallpaperManager.setWallpaperFromFile(path, location);

带错误处理的基本用法

您可能希望将其包装在一个try/catch块中，因为平台消息（像这样的插件）可能会失败。

String path = "/path/to/file/on/disk";
int location = WallpaperManager.HOME_SCREEN; // 或 location = WallpaperManager.LOCK_SCREEN;
String result;
try {
  result = await WallpaperManager.setWallpaperFromFile(path, location);
} on PlatformException {
  result = 'Failed to get wallpaper.';
}

从URL加载（使用CacheManager，图像也会保存到应用文件中）

如果您要从URL加载墙纸，应该先将其保存到磁盘，然后使用保存的图像文件的路径。

添加flutter_cache_manager或其他您想要的依赖项：

dependencies:
  ...
  flutter_cache_manager: "^1.1.3"

在Dart代码中：

String url = "";
int location = WallpaperManager.HOME_SCREEN; // 或 location = WallpaperManager.LOCK_SCREEN;
String result;
var file = await DefaultCacheManager().getSingleFile(url);
final String result = await WallpaperManager.setWallpaperFromFile(file.path, location);

从Flutter资源加载

如果您要从Flutter资源加载墙纸，您需要确保它首先在pubspec.yaml文件中被索引。

dependencies:
  ...
  flutter:
    ...
    assets:
    - assets/tmp1.jpeg

在Dart代码中：

String assetPath = "assets/tmp1.jpg";
int location = WallpaperManager.HOME_SCREEN; // 或 location = WallpaperManager.LOCK_SCREEN;
String result;
final String result = await WallpaperManager.setWallpaperFromAsset(assetPath, location);

开始使用

使用Wallpaper Manager

查看example目录以获取一个完整的示例应用程序，该应用程序使用了Wallpaper Manager。

使用Flutter

有关如何开始使用Flutter的帮助，请参阅在线文档。

注意事项

• iOS不支持从第三方应用程序更改墙纸。
  来源
• 小米/MIUI不支持直接通过Android API更改锁屏壁纸。
  来源。您可能需要考虑创建一个锁屏启动器应用程序。

已知问题

• 由于Flutter嵌入引擎的变化，您可能会遇到一个问题。
  来源。要解决此问题，您可以升级到插件的最新版本（从v.1.0.6开始直接处理v1和v2嵌入），或者更改项目中的Flutter嵌入引擎版本。
  来源。

待办事项

• ❌ 编写测试
• ✅ 添加rect值以选择性地裁剪图像
• ❌ 添加变量以重用手机设置中的壁纸
• ❌ 编写更多测试

更改日志

请参阅Changelog页面了解最近的更改。

贡献

欢迎您为该项目做出贡献。

如果您发现了一个错误或想要一个功能，但不知道如何修复/实现，请填写问题。
如果您修复了一个错误或实现了某个功能，请发送拉取请求。

完整示例代码

以下是完整的示例代码，展示了如何使用wallpaper_manager插件来设置壁纸。

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

import 'package:flutter/services.dart';
import 'package:flutter_cache_manager/flutter_cache_manager.dart';
import 'package:wallpaper_manager/wallpaper_manager.dart';

void main() => runApp(MyApp());

class MyApp extends StatefulWidget {
  [@override](/user/override)
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _platformVersion = 'Unknown';
  String _wallpaperFile = 'Unknown';
  String _wallpaperFileWithCrop = 'Unknown';
  String _wallpaperAsset = 'Unknown';
  String _wallpaperAssetWithCrop = 'Unknown';

  [@override](/user/override)
  void initState() {
    super.initState();
  }

  // 初始化平台状态
  Future<void> initPlatformState() async {
    String platformVersion;
    try {
      platformVersion = await WallpaperManager.platformVersion;
    } on PlatformException {
      platformVersion = 'Failed to get platform version.';
    }
    if (!mounted) return;
    setState(() {
      _platformVersion = platformVersion;
    });
  }

  // 设置来自文件的壁纸
  Future<void> setWallpaperFromFile() async {
    setState(() {
      _wallpaperFile = "Loading";
    });
    String result;
    var file = await DefaultCacheManager().getSingleFile(
        'https://images.unsplash.com/photo-1542435503-956c469947f6');
    try {
      result = await WallpaperManager.setWallpaperFromFile(
          file.path, WallpaperManager.HOME_SCREEN);
    } on PlatformException {
      result = 'Failed to get wallpaper.';
    }
    if (!mounted) return;
    setState(() {
      _wallpaperFile = result;
    });
  }

  // 设置带裁剪的来自文件的壁纸
  Future<void> setWallpaperFromFileWithCrop() async {
    setState(() {
      _wallpaperFileWithCrop = "Loading";
    });
    String result;
    var file = await DefaultCacheManager().getSingleFile(
        'https://images.unsplash.com/photo-1542435503-956c469947f6');
    try {
      result = await WallpaperManager.setWallpaperFromFileWithCrop(
          file.path, WallpaperManager.HOME_SCREEN, 0, 0, 800, 800);
    } on PlatformException {
      result = 'Failed to get wallpaper.';
    }
    if (!mounted) return;
    setState(() {
      _wallpaperFileWithCrop = result;
    });
  }

  // 设置来自资产的壁纸
  Future<void> setWallpaperFromAsset() async {
    setState(() {
      _wallpaperAsset = "Loading";
    });
    String result;
    String assetPath = "assets/tmp1.jpg";
    try {
      result = await WallpaperManager.setWallpaperFromAsset(
          assetPath, WallpaperManager.HOME_SCREEN);
    } on PlatformException {
      result = 'Failed to get wallpaper.';
    }
    if (!mounted) return;
    setState(() {
      _wallpaperAsset = result;
    });
  }

  // 设置带裁剪的来自资产的壁纸
  Future<void> setWallpaperFromAssetWithCrop() async {
    setState(() {
      _wallpaperAssetWithCrop = "Loading";
    });
    String result;
    String assetPath = "assets/tmp1.jpg";
    try {
      result = await WallpaperManager.setWallpaperFromAssetWithCrop(
          assetPath, WallpaperManager.HOME_SCREEN, 0, 0, 800, 800);
    } on PlatformException {
      result = 'Failed to get wallpaper.';
    }
    if (!mounted) return;
    setState(() {
      _wallpaperAssetWithCrop = result;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Column(
          children: <Widget>[
            RaisedButton(
              child: Text("Platform Version"),
              onPressed: initPlatformState,
            ),
            Center(
              child: Text('Running on: $_platformVersion\n'),
            ),
            RaisedButton(
              child: Text("Set wallpaper from file"),
              onPressed: setWallpaperFromFile,
            ),
            Center(
              child: Text('Wallpaper status: $_wallpaperFile\n'),
            ),
            RaisedButton(
              child: Text("Set wallpaper from file with crop"),
              onPressed: setWallpaperFromFileWithCrop,
            ),
            Center(
              child: Text('Wallpaper status: $_wallpaperFileWithCrop\n'),
            ),
            RaisedButton(
              child: Text("Set wallpaper from asset"),
              onPressed: setWallpaperFromAsset,
            ),
            Center(
              child: Text('Wallpaper status: $_wallpaperAsset\n'),
            ),
            RaisedButton(
              child: Text("Set wallpaper from asset with crop"),
              onPressed: setWallpaperFromAssetWithCrop,
            ),
            Center(
              child: Text('Wallpaper status: $_wallpaperAssetWithCrop\n'),
            ),
          ],
        ),
      ),
    );
  }
}