Helios Getting Started 是 Helios 视频引擎的安装与快速入门指南。Helios 是一个浏览器原生视频引擎,用于程序化动画与渲染。
用途:帮助用户在新建 Helios 项目时完成环境准备、包安装、创建第一个 composition,并将动画渲染为视频文件(如 MP4),同时支持开发期预览。
主要能力与使用方式:
- 环境要求:Node.js v18 或更高(推荐)、npm 或 yarn;渲染需要 Chrome/Chromium,由 Playwright 自动安装。FFmpeg 已通过 @ffmpeg-installer/ffmpeg 随 @helios-project/renderer 打包,无需手动安装;也可在渲染器配置中用 ffmpegPath 指定系统安装的 FFmpeg。
- 模块化安装:核心包 @helios-project/core 为必需,包含引擎逻辑、时间驱动与动画辅助;渲染器包 @helios-project/renderer 推荐安装,使用无头 Chrome 与 FFmpeg 将 composition 渲染为 MP4 等视频;播放器包 @helios-project/player 可选,提供 <helios-player> Web Component 用于预览。常用安装命令为 npm install @helios-project/core @helios-project/renderer。
- 基本设置:创建 composition.html 并引入脚本;在 JavaScript 中导入 Helios 并实例化,指定 duration、fps、width、height 和 autoSyncAnimations;将实例挂到 window.helios,渲染器和播放器通过它查找并驱动 composition;通过 helios.subscribe 订阅帧更新执行绘制;可选调用 helios.bindToDocumentTimeline() 跟随页面时钟。
- 动画同步:现有 CSS 动画无需修改即可使用,调用 helios.seek(45) 时所有 CSS/WAAPI 动画会立即更新到第 45 帧。
- 渲染视频:使用 CLI 命令 npx @helios-project/cli render ./composition.html -o output.mp4,或通过 Renderer 类编程渲染,指定尺寸、帧率、时长与 mode 等参数。
- 预览:安装 player 包后,使用 <helios-player src="./composition.html" width="1920" height="1080"></helios-player> 在开发期预览。
- 框架集成:提供 React(useVideoFrame)、Vue(useVideoFrame)、Svelte(videoFrame)以及原生 JS 订阅等方式。
适用场景:需要以代码和标准 Web 动画创建程序化视频、将 HTML/CSS/Canvas 动画渲染为 MP4 的项目,以及需要在 React、Vue、Svelte 或原生 JS 中集成的开发场景。
限制与注意事项:数据未提供具体收费、价格、授权方式、性能上限和平台兼容范围;文档仅列出 Node.js v18+ 与 Chrome/Chromium 要求。常见问题包括找不到 @helios-project/core 模块时检查安装与打包器配置;动画不同步时确认 autoSyncAnimations: true 并调用 bindToDocumentTimeline;渲染器首次运行会下载对应 Playwright 版本的无头 Chromium;手动运行 npx playwright install 可能获取不同版本;播放器无法检测 composition 时确认 window.helios = helios 及 HTML 路径。