Flutter桌面扫描插件flutter_desktop_scanner的使用

flutter_desktop_scanner

在桌面上使用物理扫描仪变得轻而易举！

开始使用

由于此插件依赖于一些系统库（SANE、WIA），你必须在你的flutter项目中设置它们。

Linux

在./linux/CMakeLists.txt文件中，在以下代码下添加：

apply_standard_settings(${BINARY_NAME})

添加：

set(LINKER_FLAGS "-lsane")
set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} ${LINKER_FLAGS}")

Windows

无需操作！WIA通常作为头文件可用。

MacOS

无需操作！MacOS 使用 ImagCaptureCore 框架，自10.14版本起应该可用。

使用插件

因为设备扫描过程以及实际扫描过程需要一些时间，所以该插件基于 EventChannels。EventChannels 类似于 MethodChannels，但用于流，这允许通过流从原生平台获取数据。因此，你总是需要先获取流引用才能启动任何操作。

获取设备

final _flutterDesktopScannerPlugin = FlutterDesktopScannerPlugin();

...

// 始终先获取流
final scannerStream = _flutterDesktopScannerPlugin.getDevicesStream();

scannerStream.listen((scanners) {
    setState(() {
    _scanners = scanners;
    _loading = false;
    });
});

// 然后调用初始化方法
await _flutterDesktopScannerPlugin.initGetDevices();

启动扫描

final _flutterDesktopScannerPlugin = FlutterDesktopScannerPlugin();

...

// 再次获取流，流返回一个可以编码为任何图像格式（如JPG、PNG）的Image类
final stream = _flutterDesktopScannerPlugin.imageReprStream();

stream.listen((image) {
    setState(() {
    if (image != null) {
        _imgBytes = img.encodePng(image);
    }
    _imgLoading = false;
    });
});

// 然后初始化扫描
await _flutterDesktopScannerPlugin.initScan(scanner);

扫描表示

imageReprStream

此流返回一个 Image 类，可以编码为任何图像格式（如 JPG、PNG 等）。完整的列表可以在这里查看：Image Formats

rawBytesStream

此流返回一个包含原始图像字节的 Uint8List。格式在每个平台上不同：

• 对于 Linux，它是 PNM。
• 对于 Windows，它很可能是 BMP 或 TIFF。
• 对于 MacOS，它是 PNG。

示例代码

以下是完整的示例代码：

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

import 'package:flutter/services.dart';
import 'package:flutter_desktop_scanner/flutter_desktop_scanner.dart';
import 'package:image/image.dart' as img;

void main() {
  WidgetsFlutterBinding.ensureInitialized();
  runApp(const MyApp());
}

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

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _platformVersion = 'Unknown';
  final _flutterDesktopScannerPlugin = FlutterDesktopScanner();
  List<Scanner> _scanners = [];
  bool _loading = false;
  bool _imgLoading = false;
  Uint8List? _imgBytes;

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

  // 平台消息是异步的，所以我们在一个异步方法中初始化。
  Future<void> initPlatformState() async {
    String platformVersion;
    // 平台消息可能失败，所以我们使用try/catch来捕获PlatformException。
    // 我们也处理消息可能返回null的情况。
    try {
      platformVersion =
          await _flutterDesktopScannerPlugin.getPlatformVersion() ??
              'Unknown platform version';
    } on PlatformException {
      platformVersion = 'Failed to get platform version.';
    }

    // 如果在异步平台消息飞行时小部件被从树中移除，我们希望丢弃回复而不是调用setState来更新我们的非存在的外观。
    if (!mounted) return;

    setState(() {
      _platformVersion = platformVersion;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('插件示例应用'),
        ),
        body: Center(
          child: Column(
            children: [
              Text('运行在: $_platformVersion\n'),
              ElevatedButton(
                onPressed: _loading ? null : _setScanner,
                child: _loading
                    ? const SizedBox(
                        width: 24.0,
                        height: 24.0,
                        child: CircularProgressIndicator.adaptive())
                    : const Text("获取扫描仪"),
              ),
              ...List.generate(
                _scanners.length,
                (index) => MouseRegion(
                  cursor: SystemMouseCursors.click,
                  child: GestureDetector(
                    onTap: () => _initiateScan(_scanners[index]),
                    child: Text(
                        "${_scanners[index].name} ${_scanners[index].model}"),
                  ),
                ),
              ),
              if (_imgBytes != null)
                Image.memory(
                  _imgBytes!,
                  width: 250,
                ),
              if (_imgLoading) const CircularProgressIndicator.adaptive(),
            ],
          ),
        ),
      ),
    );
  }

  _setScanner() async {
    setState(() {
      _loading = true;
      _scanners = [];
    });
    final scannerStream = _flutterDesktopScannerPlugin.getDevicesStream();
    scannerStream.listen((scanners) {
      setState(() {
        _scanners = scanners;
        _loading = false;
      });
    });
    await _flutterDesktopScannerPlugin.initGetDevices();
  }

  _initiateScan(Scanner scanner) async {
    setState(() {
      _imgLoading = true;
    });
    final stream = _flutterDesktopScannerPlugin.imageReprStream();
    stream.listen((image) {
      setState(() {
        if (image != null) {
          _imgBytes = img.encodePng(image);
        }
        _imgLoading = false;
      });
    });
    await _flutterDesktopScannerPlugin.initScan(scanner);
  }
}