Flutter流媒体处理插件saf_stream的使用

saf_stream 是一个用于在Flutter中读取和写入Android SAF（Storage Access Framework）文件的插件。该插件支持通过流的方式处理大文件，同时也提供了直接读取和写入文件字节的功能。

功能概述

• 文件字节操作：适用于小文件或内存不是问题的情况。

  • 读取：readFileBytes
  • 写入：writeFileBytes

• 文件流操作：适用于大文件处理。

  • 读取：readFileStream
  • 写入：startWriteStream, writeChunk, endWriteStream

• 非SAF文件操作：与标准本地文件交互。

  • 复制到本地文件：copyToLocalFile
  • 将本地文件粘贴到SAF目录：pasteLocalFile

• 自定义读取流：当需要在原生端跳过字节时使用。

  • startReadCustomFileStream, readCustomFileStreamChunk, skipCustomFileStreamChunk, endReadCustomFileStream

示例代码

下面是一个完整的示例应用，展示了如何使用saf_stream插件进行文件的读取和写入操作。

import 'dart:convert';
import 'dart:io';
import 'dart:typed_data';

import 'package:flutter/material.dart';
import 'package:saf_stream/saf_stream.dart';
import 'package:saf_util/saf_util.dart';

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

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

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

class _MyAppState extends State<MyApp> {
  final _safUtil = SafUtil();
  final _safStreamPlugin = SafStream();
  List<SafDocumentFile> _files = [];
  String? _treeUri;
  String _output = '';
  int _session = 0;

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('saf_stream Example'),
        ),
        body: SingleChildScrollView(
          child: Container(
            padding: const EdgeInsets.all(10),
            child: _treeUri == null
                ? OutlinedButton(
                    onPressed: _selectFolder,
                    child: const Text('Select a folder'))
                : Column(
                    children: [
                      Text(_output),
                      const SizedBox(height: 10),
                      OutlinedButton(
                          onPressed: _reload, child: const Text('Reload')),
                      // 其他按钮省略...
                      ...(_files.where((f) => !f.isDir).map((f) =>
                          Container(
                            padding: const EdgeInsets.all(8),
                            decoration: BoxDecoration(border: Border.all(color: Colors.grey)),
                            child: Column(
                              children: [
                                Text(f.name),
                                OutlinedButton(
                                    onPressed: () => _readFileStream(f.uri),
                                    child: const Text('Read stream')),
                                OutlinedButton(
                                    onPressed: () => _readFileBytes(f.uri),
                                    child: const Text('Read bytes')),
                              ],
                            ),
                          ))),
                    ],
                  ),
          ),
        ),
      ),
    );
  }

  Future<void> _reload() async {
    try {
      if (_treeUri == null) {
        return;
      }
      var files = await _safUtil.list(_treeUri!);
      setState(() {
        _files = files;
        _output = '';
      });
    } catch (err) {
      setState(() {
        _output = err.toString();
      });
    }
  }

  Future<void> _selectFolder() async {
    try {
      var treeUri = await _safUtil.openDirectory();
      if (treeUri == null) {
        return;
      }
      _treeUri = treeUri;
      await _reload();
    } catch (err) {
      setState(() {
        _output = err.toString();
      });
    }
  }

  Future<void> _readFileStream(String uri) async {
    try {
      _clearOutput();
      var session = ++_session;
      await for (var bytes in await _safStreamPlugin.readFileStream(uri, bufferSize: 500 * 1024)) {
        setState(() {
          _output += '$session - <Bytes:${bytes.length}>\n';
        });
      }
      setState(() {
        _output += '$session - <Done>\n';
      });
    } catch (err) {
      setState(() {
        _output = err.toString();
      });
    }
  }

  Future<void> _readFileBytes(String uri) async {
    try {
      _clearOutput();
      final bytes = await _safStreamPlugin.readFileBytes(uri);
      setState(() {
        _output += 'Read file bytes: ${bytes.lengthInBytes} \n';
      });
    } catch (err) {
      setState(() {
        _output = err.toString();
      });
    }
  }

  void _clearOutput() {
    setState(() {
      _output = '';
    });
  }
}

关键方法说明

• _readFileStream: 使用readFileStream方法从指定URI读取文件内容，并逐块显示在界面上。
• _readFileBytes: 使用readFileBytes方法直接读取整个文件的内容并显示其大小。

以上是关于saf_stream插件的基本介绍及示例代码。根据实际需求，你可以调整这些代码来满足自己的项目要求。请确保你的Android设备或模拟器的API级别不低于21。