李钟意讲前端

外观

咨询/接单/付费bug修复/学习交流群

electron vlc v1.0.4 版本需求文档 ​

  • 文档目的：统一整理 ElectronVLC 播放器 v1.0.4 的需求背景和功能需求，指导后续开发、测试和发布。
  • 适用人员：项目经理、开发、测试、UI/UE 设计、运维等。

一、需求背景 ​

  1. 播放标题显示：通过主窗口播放视频时，能够在播放窗口（以及任务栏）显示当前文件标题。
  2. 版本信息可见：用户希望随时查看播放器版本号。
  3. 环境配置及使用教程：需要详细的开发环境搭建指南和接口文档，帮助开发者快速上手。
  4. 功能展示：需要在文档上直观展示当前支持的功能（多音轨、多字幕切换、添加字幕等）。
  5. 多音轨/多字幕切换：针对部分 iPhone16 录制的视频（多音轨、多字幕），需要自由切换音轨和字幕轨道。
  6. 历史记录：用户希望记录播放历史，便于快速回放。
  7. 自动升级：支持检测新版本并自动升级。

二、需求描述 ​

1.播放窗口显示标题 ​

  1. 播放窗口标题：播放窗口的标题栏应显示正在播放的文件名称。
  2. Windows 任务栏标题：在 Windows 系统下，任务栏的窗口标题也应同步显示正在播放的文件名称。

2.显示版本 ​

  1. 界面展示：播放器左下角或显著区域显示应用的版本号（示例：v1.0.4）。
  2. 与升级功能结合：当检测到新版本时，在此处可以进行“升级”或“查看更新内容”的交互。（后续支持）

3.环境配置和使用文档 ​

  1. 环境搭建教程
    • Windows/Mac 下的开发环境安装步骤（Electron、Node.js 版本、依赖库等），确保在同一环境下可复现。
  2. VLC 动态库插件接口文档
    • 详细列出各接口方法的名称、参数、返回值及其功能说明。
    • 说明使用示例或典型调用场景。
  3. 项目集成方式
    • 如何在其他项目中引入 VLC 播放器（示例：通过 npm、yarn 或手动引入库的方式）。
  4. 源代码精简说明
    • 说明如何移除非必要的源代码或配置文件。
    • 列出主要配置文件的作用和典型修改方式。

4.代码兼容性以及系统的兼容 ​

  1. 操作系统与 Electron 版本
    • 列举 Windows 和 macOS 上支持的 Electron 版本范围。
    • 明确不再支持的系统：如 Windows 32 位、Windows 7、Linux 等。
  2. 后续兼容性扩展
    • 如果未来需要适配 Linux 或更高版本的 macOS，需在此备注规划。

5.支持添加字幕、切换字幕轨道、切换音频轨道 ​

  1. 轨道列表展示
    • 鼠标悬停（Hover）在字幕/音频轨道图标上时，显示可用的音轨、字幕轨道列表。
  2. 添加/切换字幕文件
    • 支持在播放过程中手动添加本地字幕文件。
    • 切换到新字幕后即时生效。

6.播放历史记录 ​

界面布局 ​

  1. 左侧区域
    • 显示 ElectronVLC 的 Logo
    • 左下角显示播放器版本号
  2. 右侧区域（上下结构）
    • 顶部
      • “选择文件”按钮
      • “输入框”：可输入 http/https/rtsp/本地文件路径
      • “播放视频”按钮
      • 若有历史记录，顶部也可显示最近播放的条目（本地存储）
    • 下方列表区域
      • 用于显示历史播放记录

历史记录功能描述 ​

  1. 添加记录
    • 支持点击、拖拽的方式把文件加入播放历史。
  2. 无播放记录时
    • 显示提示文案，如“暂无播放历史”；可直接拖拽文件进来播放。
  3. 播放记录列表
    • 分页显示（可选 5/10/20/30/100 条/页），支持点击页码切换
    • 列：
      • 文件名称（支持排序，Hover 显示完整路径，中间省略号）
      • 添加时间（默认降序，可升序或降序）
      • 操作（删除、播放、文件夹中显示）
  4. 播放/删除操作
    • 播放：点击播放，在新窗口播放；若已有正在播放的文件，则自动切换播放到新文件。
    • 编辑：点击编辑把路径填充到顶部的输入框中。
    • 文件夹中显示：打开文件所在文件夹并选中该文件；若文件被删除，则提示“文件已被移除”并以红字警示。
    • 删除：移除该条历史记录。

7.自动更新升级 app ​

  1. 不升级，不会有任何升级提示
  2. 仅红点提示升级
    • 检测到可更新版本时，在版本号处显示红点提示。
    • 若用户不进行更新，红点将一直存在。
    • 用户点击版本号处的红点可唤起升级弹窗。
  3. 弱提示升级
    • 首次发现新版本时即弹出升级提示窗。
    • 若用户关闭该窗口，不会再次自动弹出；但版本号处仍会显示红点。
    • 用户可通过点击红点再次打开升级弹窗。
  4. 强提示升级
    • 首次发现新版本时弹出强提示升级窗。
    • 若用户关闭该窗口，当天内不再重复弹出，但版本号处依然保留红点。
    • 当距离用户上次点击关闭超过 24 小时，将再次自动弹出升级提示窗，直至用户升级为止。
  5. 强制提示升级
    • 出现不可关闭的升级弹窗，用户必须立即升级。
    • 未完成升级前，无法继续使用当前 APP。

三、测试与验收标准 ​

1. 测试范围 ​

  • 功能测试：多音轨/字幕切换、历史记录、版本显示、自动更新等
  • 兼容性测试：Windows 10、Windows 11、macOS（arm64/x64）的 Electron 环境
  • 性能测试：播放流畅度、文件切换时的响应速度

2. 验收准则 ​

  • 核心功能均可正常使用，无严重崩溃或卡顿
  • 历史记录新增/删除/播放/拖拽功能符合预期
  • 自动升级提示符合策略，升级流程可完成
  • 版本信息、音轨与字幕切换等功能均已实现并稳定

四、研发需求拆解 ​

序号需求名称耗时开始时间结束时间状态备注
1播放窗口显示标题4h2024/12/222024/12/22已完成
2显示版本0.5h2024/12/222024/12/22已完成
3环境配置和使用文档8h2024/12/222024/12/22待开始
4代码兼容性以及系统的兼容1h2024/12/222024/12/22待开始
5支持添加字幕、切换字幕轨道、切换音频轨道2h2024/12/222024/12/22待开始
6播放历史记录6h---待定
7自动更新升级 app12h---待定 （前端、后端支持）