# @hyperframes/engine 中文文档

规范地址：https://npmcn.com/package/%40hyperframes/engine/

版本：0\.8\.226
npm 元数据更新时间：2026-11-01T06:33:14.118Z
中文译文更新时间：2026-11-01T10:08:36.900Z
软件包许可：未声明

本文由上游 README 机器翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40hyperframes/engine
原文对照：https://npmcn.com/package/%40hyperframes/engine/?lang=original
项目主页：https://github.com/heygen-com/hyperframes#readme
源码仓库：https://github.com/heygen-com/hyperframes

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：1.6 MB，167 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：8 个
- 首次发布：2026-03-23T01:08:10.101Z
- 最新版本发布：2026-11-01T06:33:13.796Z
- 已发布版本数：581（近 12 个月 581 个）

## 中文简介

可搜索的网页视频渲染引擎（Puppeteer + FFmpeg）

## 安装

```sh
npm install @hyperframes/engine
```

也可以使用：`pnpm add @hyperframes/engine`、`yarn add @hyperframes/engine`、`bun add @hyperframes/engine`

## README

# @hyperframes /引擎

可搜索的网页到视频渲染引擎建立在木偶和FFmpeg。

框架无关：适用于GSAP、Lottie、Three.js、CSS动画或任何实现 `window.__hf` 寻求协议。

## 安装

```bash
npm install @hyperframes/engine
```

**要求:** Node.js >= 22, Chrome/Chromium（由Puppeteer自动下载），FFmpeg

## 它是做什么的

引擎打开你的HTML组合在一个无头的Chrome实例，寻找逐帧使用Chrome的 `HeadlessExperimental.beginFrame` API，捕获屏幕截图，并使用FFmpeg将其编码为视频。

### 关键服务

| 服务 | 描述 |
| --- | --- |
| **browserManager** | 启动和汇集无头Chrome实例(`chrome-headless-shell`） |
| **frameCapture** | 管理捕获会话-查找，截图，缓冲区生命周期 |
| **screenshotService** | 基于beginfrastructure的捕获与CDP （Chrome DevTools协议） |
| **chunkEncoder** | FFmpeg编码与分块连接，GPU检测，快速启动 |
| **streamingEncoder** | 实时将帧传输到FFmpeg（磁盘上没有中间png） |
| **audioMixer** | 解析 `<audio>` 元素和混合音轨通过FFmpeg |
| **videoFrameExtractor** | 从 `<video>` 合成元素 |
| **parallelCoordinator** | 跨工作进程拆分帧范围 |
| **服务器** | 通过Hono向浏览器提供本地HTML文件 |

## 使用

```typescript
import {
  acquireBrowser,
  createCaptureSession,
  initializeSession,
  captureFrame,
  closeCaptureSession,
} from "@hyperframes/engine";

// 1. Launch browser
const browserLease = await acquireBrowser({ captureMode: "beginFrame" });

// 2. Open a capture session
const session = createCaptureSession({
  browser: browserLease.browser,
  url: "http://localhost:3000/my-composition.html",
  width: 1920,
  height: 1080,
  fps: 30,
});
await initializeSession(session);

// 3. Capture frames
for (let i = 0; i < totalFrames; i++) {
  await captureFrame(session, i, `/tmp/frames/frame-${i}.png`);
}

// 4. Clean up
await closeCaptureSession(session);
await browserLease.release();
```

大多数用户应该使用 `@hyperframes/producer` 或者是 `hyperframes` 命令行，而不是直接调用引擎。

## 文档

完整的文档: [hyperframes.heygen.com/packages/engine](https://hyperframes.heygen.com/packages/engine)

## 相关的包

-   [`@hyperframes/core`](https://npmcn.com/package/%40hyperframes/core) -类型，解析器，帧适配器
-   [`@hyperframes/producer`](https://npmcn.com/package/%40hyperframes/producer) -在此引擎上构建的高级渲染管道
-   [`hyperframes`](https://npmcn.com/package/%40hyperframes/cli) - - - - - - CLI

## 常见问题

### @hyperframes/engine 是什么？

可搜索的网页视频渲染引擎（Puppeteer \+ FFmpeg）

### 如何安装 @hyperframes/engine？

在项目目录运行 npm install @hyperframes/engine，或使用 pnpm add / yarn add / bun add。

### @hyperframes/engine 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @hyperframes/engine 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @hyperframes/engine 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @hyperframes/engine 可以商用吗？

@hyperframes/engine 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @hyperframes/engine 还在维护吗？

最新版本 0\.8\.226 发布于 2026/11/01（2 天前）；至今共发布 581 个版本，其中过去 12 个月发布了 581 个；首次发布于 2026/03/23。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。