阅读 4343

Flutter:基于video_player实现视频相关手势控制、全屏播放

简介

最近公司需要开发视频播放的功能,官方提供的video_player除了视频播放功能就没有提供其他的控制功能,包括最基本的全屏播放功能。同时也比较了一下第三方组件也不是很能满足需求。那我们就只好自己动手在video_player基础上进行改造。由于使用的纯flutter进行开发android、ios上界面一致。废话不多说直接上图:

1. 主要功能

  1. 轻触屏幕弹出控制按钮(进度条、全屏播放按钮、暂停播放按钮、标题)
  2. 右侧滑动控制音量
  3. 左侧滑动控制亮度
  4. 水平滑动快进快退
  5. 双击暂停播放
  6. 播放时屏幕常亮

2. 安装组件

video_player: ^0.10.5    
auto_orientation: ^1.0.5   //控制横竖屏控件
screen: ^0.0.5             //控制屏幕亮度以及屏幕常亮组件
common_utils: ^1.1.3       //格式化时间日期组件
复制代码

3. 组件结构

为了代码可读性,我将该组件拆分成了3个控件,分别为 控制按钮控件手势滑动控件视频播放播放控件。这三个控件依次嵌套默认填充满父控件。由于嵌套层数比较多,层层传递属性有点麻烦,因此我们这里使用一个InheritedWidget共享数据:

import 'package:flutter/material.dart';
import 'package:video_player/video_player.dart';
import 'video_player_control.dart';

class ControllerWidget extends InheritedWidget {
  ControllerWidget({
      this.controlKey,
      this.child,
      this.controller,
      this.videoInit,
      this.title
    });

    final String title;
    final GlobalKey<VideoPlayerControlState> controlKey;
    final Widget child;
    final VideoPlayerController controller;
    final bool videoInit;

  //定义一个便捷方法,方便子树中的widget获取共享数据
  static ControllerWidget of(BuildContext context) {
    return context.dependOnInheritedWidgetOfExactType<ControllerWidget>();
  }

  @override
  bool updateShouldNotify(InheritedWidget oldWidget) {
    // TODO: implement updateShouldNotify
    return false;
  }

}
复制代码

这里面VideoPlayerController这个controller我们后面会经常使用,用于调用操作视频相关api。

4. 入口控件VideoPlayerUI

4.1. 定义属性

这里定义了三种读取视频的方式networkassetfile,分别对应网络视频工程视频本地视频文件

class VideoPlayerUI extends StatefulWidget {
  VideoPlayerUI.network({
    Key key,
    @required String url, // 当前需要播放的地址
    this.width: double.infinity, // 播放器尺寸(大于等于视频播放区域)
    this.height: double.infinity,
    this.title = '', // 视频需要显示的标题
  })  : type = VideoPlayerType.network,
        url = url,
        super(key: key);

  VideoPlayerUI.asset({
    Key key,
    @required String dataSource, // 当前需要播放的地址
    this.width: double.infinity, // 播放器尺寸(大于等于视频播放区域)
    this.height: double.infinity,
    this.title = '', // 视频需要显示的标题
  })  : type = VideoPlayerType.asset,
        url = dataSource,
        super(key: key);

  VideoPlayerUI.file({
    Key key,
    @required File file, // 当前需要播放的地址
    this.width: double.infinity, // 播放器尺寸(大于等于视频播放区域)
    this.height: double.infinity,
    this.title = '', // 视频需要显示的标题
  })  : type = VideoPlayerType.file,
        url = file,
        super(key: key);

  final url;
  final VideoPlayerType type;
  final double width;
  final double height;
  final String title;

  @override
  _VideoPlayerUIState createState() => _VideoPlayerUIState();
}
复制代码

4.2. 初始化视频

4.2.1. 初始化

首先我们需要在initState生命周期中对视频进行初始化,对视频是否加载成功显示不同的UI界面:加载中、加载成功、加载失败。

  void _urlChange() async {
    if (widget.url == null || widget.url == '') return;
    if (_controller != null) {
      /// 如果控制器存在,清理掉重新创建
      _controller.removeListener(_videoListener);
      _controller.dispose();
    }
    setState(() {
      /// 重置组件参数
      _videoInit = false;
      _videoError = false;
    });
    if (widget.type == VideoPlayerType.file) {
      _controller = VideoPlayerController.file(widget.url);
    } else if (widget.type == VideoPlayerType.asset) {
      _controller = VideoPlayerController.asset(widget.url);
    } else {
      _controller = VideoPlayerController.network(widget.url);
    }

    /// 加载资源完成时,监听播放进度,并且标记_videoInit=true加载完成
    _controller.addListener(_videoListener);
    await _controller.initialize();
    setState(() {
      _videoInit = true;
      _videoError = false;
      _controller.play();
    });
  }
复制代码

这里有一个需要注意的点:_controller.addListener(_videoListener);我们添加监听一定要在初始化之前添加,不然后续的加载状态无法响应。在监听函数中我们这里使用了GlobalKey去调用组件方法,刷新子组件时间显示的页面显示

  void _videoListener() async {
    if (_controller.value.hasError) {
      setState(() {
        _videoError = true;
      });
    } else {
      Duration res = await _controller.position;
      if (res >= _controller.value.duration) {
        await _controller.seekTo(Duration(seconds: 0));
        await _controller.pause();
      }
      if (_controller.value.isPlaying && _key.currentState != null) {
        /// 减少build次数
        _key.currentState.setPosition(
          position: res,
          totalDuration: _controller.value.duration,
        );
      }
    }
  }
复制代码

4.2.2. 改变视频源

在传入的url发生改变的时候,重新初始化视频,这里我们就需要用到didUpdateWidget这个生命周期:

  @override
  void didUpdateWidget(VideoPlayerUI oldWidget) {
    if (oldWidget.url != widget.url) {
      _urlChange(); // url变化时重新执行一次url加载
    }
    super.didUpdateWidget(oldWidget);
  }
复制代码

4.3. 完整代码

VideoPlayerUI完整代码

5. 视频控制按键VideoPlayerControl

5.1 轻触显示界面

该组件主要的功能就是,轻触屏幕会弹出操作按钮,过两秒后按钮会消失,这里我们就需要一个Timer定时器,每次点击屏幕就会取消之前的操作,重新开始计时:

  void _togglePlayControl() {
    setState(() {
      if (_hidePlayControl) {
        /// 如果隐藏则显示
        _hidePlayControl = false;
        _playControlOpacity = 1;
        _startPlayControlTimer(); // 开始计时器,计时后隐藏
      } else {
        /// 如果显示就隐藏
        if (_timer != null) _timer.cancel(); // 有计时器先移除计时器
        _playControlOpacity = 0;
        Future.delayed(Duration(milliseconds: 500)).whenComplete(() {
          _hidePlayControl = true; // 延迟500ms(透明度动画结束)后,隐藏
        });
      }
    });
  }
  
  void _startPlayControlTimer() {
    /// 计时器,用法和前端js的大同小异
    if (_timer != null) _timer.cancel();
    _timer = Timer(Duration(seconds: 3), () {
      /// 延迟3s后隐藏
      setState(() {
        _playControlOpacity = 0;
        Future.delayed(Duration(milliseconds: 500)).whenComplete(() {
          _hidePlayControl = true;
        });
      });
    });
  }
复制代码

5.2 全屏播放

当我们点击全屏操作只需要将屏幕强制切换为横屏,同时将系统设置为全屏模式

  void _toggleFullScreen() {
    setState(() {
      if (_isFullScreen) {
        /// 如果是全屏就切换竖屏
        AutoOrientation.portraitAutoMode();

        ///显示状态栏,与底部虚拟操作按钮
        SystemChrome.setEnabledSystemUIOverlays(
            [SystemUiOverlay.top, SystemUiOverlay.bottom]);
      } else {
        AutoOrientation.landscapeAutoMode();

        ///关闭状态栏,与底部虚拟操作按钮
        SystemChrome.setEnabledSystemUIOverlays([]);
      }
      _startPlayControlTimer(); // 操作完控件开始计时隐藏
    });
  }
复制代码

5.3 刷新进度条

该方法供视频的监听函数里面进行调用,以让进度条实时更新

  // 供父组件调用刷新页面,减少父组件的build
  void setPosition({position, totalDuration}) {
    setState(() {
      _position = position;
      _totalDuration = totalDuration;
    });
  }
复制代码

5.4 完整代码

VideoPlayerControl完整代码

VideoPlayerSlider进度条完整代码

6. 手势控制控件VideoPlayerPan

6.1 手势控制方法

对于手势控制这里其实没什么难度,无非就是通过滑动距离/屏幕宽(高)获取百分比加上当前的值,然后在设置亮度、音量、进度。这里我需要注意一定要给VideoPlayerControl的container设置一个背景透明色,不然该控件无法响应手势(感觉这里写的不够优雅,有什么好的解决办法评论告诉我):

  @override
  Widget build(BuildContext context) {
    return GestureDetector(
      onDoubleTap: _playOrPause,
      onTap: _togglePlayControl,
      child: Container(
        width: double.infinity,
        height: double.infinity,
        // 这里需要价格透明色,不然无法响应手势,有没有大佬知道更加优雅点的方式
        color: Colors.transparent,
        child: WillPopScope(
          child: Offstage(
            offstage: _hidePlayControl,
            child: AnimatedOpacity(
              // 加入透明度动画
              opacity: _playControlOpacity,
              duration: Duration(milliseconds: 300),
              child: Column(
                children: <Widget>[_top(), _middle(), _bottom(context)],
              ),
            ),
          ),
          onWillPop: _onWillPop,
        ),
      ),
    );
  }
复制代码

6.2 完整代码

这个控件就不多讲了,直接上完整代码

完整代码VideoPlayerPan

7. 使用方式

import 'package:flutter/material.dart';
import 'package:richway_flutter_cli/common/video/video_player_UI.dart';

class VideoPage extends StatelessWidget {
  static final String routerName = '/VideoPage';

//  Size get _window => MediaQueryData.fromWindow(window).size;

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      backgroundColor: Colors.black,
      body: Center(
        // 该组件宽高默认填充父控件,你也可以自己设置宽高
        child: VideoPlayerUI.network(
          url:
          'https://gss3.baidu.com/6LZ0ej3k1Qd3ote6lo7D0j9wehsv/tieba-smallvideo-transcode-crf/60609889_0b5d29ee8e09fad4cc4f40f314d737ca_0.mp4',
          title: '示例视频',
        ),
      ),
    );
  }
}

复制代码

结语

写到这里,视频组件讲解完了,如果刚好对你有用欢迎在我github上给个start、或者给这篇文章点个赞,谢谢大家了,源码拷过去就能用!

源码地址