Flutter SFTP视频播放插件sftp_video_player的使用

简介

这是一个基于官方Flutter包video_player构建的简单视频播放器。该插件实现了从SFTP文件中播放视频的功能。我创建这个包的主要原因是练习，并且当我尝试使用SFTP协议从服务器流式传输视频时，我发现使用默认的Flutter video_player包存在一些困难。希望这样的包能为其他人带来便利。

功能

通过DartSSH2包实现从SFTP文件播放视频。基本功能基于video_player包，因此也可以与Chewie一起使用。

开始使用

要求

与video_player包的要求相同，确保在Android设备上，AndroidManifest文件中授予了互联网权限，并且允许明文流量，除非你选择使用带有SSL证书的安全连接。该插件使用shelf来创建HTTP服务器，并通过使用SecurityContext类可以绕过此限制。

对于iOS设备，需要在Info.plist文件中添加关于NSAppTransportSecurity键的条目，包括字典条目（NSAllowsLocalNetworking和NSAllowsArbitraryLoads）。

对于Web平台，限制条件与dartssh2包使用的原生套接字相同。

为了帮助你满足这些前提条件，请遵循示例文件夹中的测试版本。

使用方法

使用SftpVideoPlayerController从SftpFile源实例化一个video_player。由于该类扩展了VideoPlayerController，因此可以与VideoPlayer小部件或ChewieController一起使用。

final SftpFile file;
SftpVideoPlayerController? _controller;

[@override](/user/override)
void initState(){
    super.initState();
    _controller = SftpVideoPlayerController(file,
    videoFormat: StreamVideoFormat.mp4,
    serverConfig: VideoServerConfig(hostname: '127.0.0.1', port: 8080, ssl: false));
    _controller!.initialize().then((value) {
        _initialized = true;
        _controller!.play();
        setState(() {});
    });
}

[@override](/user/override)
Widget build(BuildContext context) {
    return VideoPlayer(_controller!));
}

完整示例

以下是一个完整的示例，展示了如何使用SftpVideoPlayerController来播放视频。

import 'package:dartssh2/dartssh2.dart';
import 'package:flutter/material.dart';
import 'package:sftp_video_player/sftp_video_player.dart';
import 'test_conf.dart' as test_config;

Future<void> main() async {
  final file = await test_config.getTestFile();
  runApp(MyApp(file: file));
}

class MyApp extends StatefulWidget {
  final SftpFile file;
  const MyApp({super.key, required this.file});

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

class _MyAppState extends State<MyApp> {
  SftpVideoPlayerController? _controller;
  bool _initialized = false;

  [@override](/user/override)
  void initState() {
    super.initState();
    debugPrint('Started playing: ${widget.file}');
    () async {
      final fileStat = await widget.file.stat();
      debugPrint(fileStat.toString());
    }();
    _controller = SftpVideoPlayerController(widget.file,
        videoFormat: test_config.videoFormat,
        serverConfig: test_config.serverConfig);
    _controller!.addListener(() {
      setState(() {});
    });
    _controller!.initialize().then((value) {
      _initialized = true;
      _controller!.play();
      setState(() {});
    });
  }

  [@override](/user/override)
  void dispose() {
    super.dispose();
    _controller?.dispose();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    if (_initialized) {
      return MaterialApp(
        home: Scaffold(
          backgroundColor: Colors.black,
          body: SizedBox.expand(
              child: Center(
            child: Column(
              mainAxisSize: MainAxisSize.min,
              children: [
                AspectRatio(
                    aspectRatio: 16 / 9, child: VideoPlayer(_controller!)),
                VideoProgressIndicator(
                  _controller!,
                  allowScrubbing: true,
                ),
                Row(
                  children: [
                    IconButton(
                        onPressed: () {
                          if (_controller!.value.isPlaying) {
                            _controller!.pause();
                          } else {
                            _controller!.play();
                          }

                          setState(() {});
                        },
                        color: Colors.white,
                        icon: Icon(_controller!.value.isPlaying
                            ? Icons.pause
                            : Icons.play_arrow)),
                    IconButton(
                        color: Colors.white,
                        onPressed: () {
                          _controller!.seekTo(const Duration(seconds: 0));

                          setState(() {});
                        },
                        icon: const Icon(Icons.refresh))
                  ],
                )
              ],
            ),
          )),
        ),
      );
    } else {
      return const Center(
        child: CircularProgressIndicator(),
      );
    }
  }
}