* fix(engine,producer): render media readers treat private project files as missing A video, audio, GIF or HEIC src that names a file the file servers refuse (git metadata, env, credentials, tool state, app records), as written or through a link, is now treated as missing by every render-time reader: the compile-time duration probe and keyframe advisory, GIF and HEIC prep, the media drop step, the HDR probe, frame extraction and the audio mixer. The engine's isPrivateUnderAssetRoots judges a path from every asset root that holds it, so a render's own work folder inside the project's .hyperframes/ keeps its downloaded and prepared files. * fix(engine): probe refuses a text file that ffmpeg reads as text-art video ffmpeg's tty and bintext demuxers turn a text file (such as .asc or .nfo) into a video stream that draws the text into frames. Every probe now refuses an input whose container is tty or whose video codec is ansi, bintext, xbin or idf, as not media. Probing, frame extraction and audio reads all go through the same probe, on every render. No demuxer for real video or audio produces these, so local renders keep every other format. * fix(engine,producer,cli): playlist entries and check probes skip private files - A media playlist (HLS segment, key or map URI, ffconcat file) that names a private file inside its own folder is refused as not media, like one that names a file outside it. - `hyperframes check` no longer probes a media source outside the project or private in it: mediaPath returns null for such a file and the audio, heard-clip and HDR checks skip it. - The compiler's duration probe and keyframe check judge privacy from every asset root, as the render-time readers do.
@hyperframes/engine
Seekable web-page-to-video rendering engine built on Puppeteer and FFmpeg.
Framework-agnostic: works with GSAP, Lottie, Three.js, CSS animations, or any web content that implements the window.__hf seek protocol.
Install
npm install @hyperframes/engine
Requirements: Node.js >= 22, FFmpeg, and the pinned chrome-headless-shell: run npx hyperframes browser ensure once, or name a browser in PRODUCER_HEADLESS_SHELL_PATH. A cached browser is used only when its files match the pinned build. HDR capture needs a full Chrome named in HYPERFRAMES_BROWSER_PATH.
What it does
The engine opens your HTML composition in a headless Chrome instance, seeks frame-by-frame using Chrome's HeadlessExperimental.beginFrame API, captures screenshots, and encodes them into video with FFmpeg.
Key services
| Service | Description |
|---|---|
| browserManager | Launches and pools headless Chrome instances (chrome-headless-shell) |
| frameCapture | Manages capture sessions — seek, screenshot, buffer lifecycle |
| screenshotService | BeginFrame-based capture with CDP (Chrome DevTools Protocol) |
| chunkEncoder | FFmpeg encoding with chunked concat, GPU detection, faststart |
| streamingEncoder | Pipe frames to FFmpeg in real time (no intermediate PNGs on disk) |
| audioMixer | Parse <audio> elements and mix audio tracks via FFmpeg |
| videoFrameExtractor | Extract frames from <video> elements for compositing |
| parallelCoordinator | Split frame ranges across worker processes |
| fileServer | Serve local HTML files to the browser via Hono |
Usage
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();
Most users should use @hyperframes/producer or the hyperframes CLI instead of calling the engine directly.
Documentation
Full documentation: hyperframes.heygen.com/packages/engine
Related packages
@hyperframes/core— types, parsers, frame adapters@hyperframes/producer— high-level render pipeline built on this enginehyperframes— CLI