Flutter屏幕捕获插件screen_capture的使用

Flutter屏幕捕获插件screen_capture的使用

描述

screen_capture 是一个Flutter插件，专为macOS和iOS设计，用于录制屏幕并捕获系统音频（非麦克风）。该插件旨在与Flutter应用程序无缝集成，目前仅支持macOS和iOS平台的屏幕录制功能。

功能特性

• 屏幕录制功能：支持macOS和iOS平台的屏幕录制。
• 系统音频录制：仅捕获系统音频，不包括麦克风输入。
• 可自定义的录制设置：可以根据需求调整录制参数。
• 简单的API：提供简单易用的API来启动和停止录制。

安装

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

dependencies:
  screen_capture:
    git:
      url: https://github.com/TheBilalJaved/screen_capture.git

然后运行以下命令以安装插件：

flutter pub get

使用方法

1. 导入插件 在Dart代码中导入 screen_capture 包：

   import 'package:screen_capture/screen_capture.dart';
   

2. 启动和停止录制 使用 startRecording 和 stopRecording 方法来管理录制会话：

   // 启动录制
   await FlutterScreenCapture.startRecording();
   
   // 停止录制
   await FlutterScreenCapture.stopRecording();
   

3. 保存和播放录制文件 录制完成后，可以将录制文件保存到本地，并使用媒体播放器进行回放。

权限设置

确保您的macOS应用程序具有必要的权限：

1. 打开 macos/Runner/Info.plist 文件。

2. 添加以下键以请求屏幕录制权限：

   <key>NSCameraUsageDescription</key>
   <string>我们需要访问以录制屏幕。</string>
   <key>NSMicrophoneUsageDescription</key>
   <string>我们需要访问以在屏幕录制期间捕获系统音频。</string>
   

注意事项

• 该插件目前仅支持macOS和iOS平台。
• 插件仅捕获系统音频，不包括麦克风输入。
• 音频通过 AVAudioEngine 捕获，如有需要可以进一步自定义。

许可证

MIT License。详情请参阅LICENSE文件。

示例代码

以下是一个完整的示例demo，展示了如何使用 screen_capture 插件进行屏幕录制：

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

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

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Screen Recorder Example',
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Screen Recorder Example'),
        ),
        body: const ScreenRecorderWidget(),
      ),
    );
  }
}

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

  [@override](/user/override)
  State<ScreenRecorderWidget> createState() => _ScreenRecorderWidgetState();
}

class _ScreenRecorderWidgetState extends State<ScreenRecorderWidget> {
  String _status = "Ready to Record";

  void _startRecording() async {
    try {
      final result = await FlutterScreenCapture.startRecording();
      setState(() {
        _status = result; // 更新状态为录制开始后的返回结果
      });
    } catch (e) {
      setState(() {
        _status = "Error starting recording: $e"; // 捕获并显示错误信息
      });
    }
  }

  void _stopRecording() async {
    try {
      final result = await FlutterScreenCapture.stopRecording();
      setState(() {
        _status = result; // 更新状态为录制停止后的返回结果
      });
    } catch (e) {
      setState(() {
        _status = "Error stopping recording: $e"; // 捕获并显示错误信息
      });
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Center(
      child: Column(
        mainAxisAlignment: MainAxisAlignment.center,
        children: [
          Text(_status), // 显示当前状态
          Row(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              ElevatedButton(
                onPressed: _startRecording, // 点击按钮启动录制
                child: const Text("Start Recording"),
              ),
              const SizedBox(width: 20), // 添加间距
              ElevatedButton(
                onPressed: _stopRecording, // 点击按钮停止录制
                child: const Text("Stop Recording"),
              ),
            ],
          ),
        ],
      ),
    );
  }
}