mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-16 22:58:02 +00:00
The §4c item here was "four hand-rolled wet/dry shells whose dispose lists have already drifted". Reading them, the drift is one specific thing and it is a leak, not an untidiness: the chorus and the phaser stopped their LFO and left it out of the nodes they disconnect. So every chain rebuild that dropped a modulated effect left a modulator still wired to the delay or the allpass bank it had been driving. Nothing audible came of it — the shell around it was disconnected — but the nodes stayed reachable, and a session of edits to a modulated track piled them up. Same shape as the worklet leak fixed earlier on this stack. `stopLfo` becomes `retireLfo` and does both halves, which is the whole fix. The consolidation the item also asks for is not here: the four shells are wired differently enough (a feedback loop, a modulated delay, six allpass stages between two trims, a convolver) that one factory over them would need a config surface bigger than the four dispose lines it replaces. The leak was the part with a defect behind it. Also folds the two artifact build scripts together — 50 lines each, differing in five names. That one is a genuine copy, and the copy is where a divergence would hide: whichever stopped being edited would go on producing a subtly different artifact with nothing to say so. Output is byte-identical, which `check:position-edits-render` proves by diffing the tracked artifact. Falsified: dropping the `disconnect` fails the new test. core 1726 passing (110 files), engine services 736 passing / 3 skipped.
@hyperframes/core
Types, parsers, generators, compiler, linter, runtime, and frame adapters for the Hyperframes video framework.
Install
npm install @hyperframes/core
Most users don't need to install core directly — the CLI, producer, and studio packages depend on it internally.
What's inside
| Module | Description |
|---|---|
| Types | TimelineElement, CompositionSpec, Asset, canvas dimensions, defaults |
| Parsers | parseHtml — extract timeline elements from HTML; parseGsapScript — parse GSAP animations |
| Generators | generateHyperframesHtml — produce valid Hyperframes HTML from a composition spec |
| Compiler | compileTimingAttrs — resolve data-start / data-duration into absolute times |
| Linter | lintHyperframeHtml — validate Hyperframes HTML (missing attributes, overlapping tracks, etc.) |
| Runtime | IIFE script injected into the browser — manages seek, media playback, and the window.__hf protocol |
| Frame Adapters | Pluggable animation drivers (GSAP, Lottie, CSS, or custom) |
Frame Adapters
A frame adapter tells the engine how to seek your animation to a specific frame:
import { createGSAPFrameAdapter } from "@hyperframes/core";
const adapter = createGSAPFrameAdapter({
getTimeline: () => gsap.timeline(),
compositionId: "my-video",
});
Implement FrameAdapter for custom animation runtimes:
import type { FrameAdapter } from "@hyperframes/core";
const myAdapter: FrameAdapter = {
id: "my-adapter",
getDurationFrames: () => 300,
seekFrame: (frame) => {
/* seek your animation */
},
};
Parsing and generating HTML
import { parseHtml, generateHyperframesHtml } from "@hyperframes/core";
const { elements, metadata } = parseHtml(htmlString);
const html = generateHyperframesHtml(spec);
Linting
import { lintHyperframeHtml } from "@hyperframes/core/lint";
const result = lintHyperframeHtml(htmlString);
// result.findings: { severity, message, elementId }[]
Documentation
Full documentation: hyperframes.heygen.com/packages/core
Related packages
@hyperframes/engine— rendering engine that drives the browser@hyperframes/producer— full render pipeline (capture + encode)hyperframes— CLI