* fix(engine): video warnings show control characters in the src as visible escapes The missing-source and opaque-alpha warnings pass the authored src, and the path built from it, through terminalText before writing them to stderr. * fix(cli): snapshot never probes or decodes a private project file for a page video projectLocalFile applies the same private-file rule as the render readers, judged as written and with links resolved, so held-video probes and frame injection skip those files. Studio's own prepared-assets and requests folders still resolve. * fix(parsers,engine): media inputs never select a text-art demuxer The media format allowlist leaves out tty, bin, xbin, idf and adf, so ffmpeg and ffprobe cannot draw a text file as a video frame, whether or not ffprobe is installed. ffprobe's refusal of one of these formats still reports the source as a text file. A link inside the project whose target is outside it is still read by snapshot: links a person puts in their own project are accepted, imported projects cannot carry links, and render reads them the same way. * fix(cli): registry warnings show control characters as visible escapes A project's hyperframes.json can name the registry, so item names and deprecation text from it pass through terminalText before the studio install, remote template and item-loading warnings write them to stderr. * fix(cli): failed render and frame read messages escape control characters The render failure box escapes each line of the message, keeping its line breaks, and snapshot's frame read errors escape the path and the ffmpeg or ffprobe text they quote. * test(cli): probe a missing path with control characters instead of creating it Windows cannot create a file with those characters in its name; the failed probe's message still carries the path.
@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