mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-16 22:58:02 +00:00
Two fixes and the wiring that makes the script reachable. CORRECTNESS: the levelling stage now goes in FRONT of a trailing limiter instead of being appended after it. The likely sequence is "apply Clean Voice, then even out the levels", and Clean Voice ends in a Peak Ceiling — so appending put up to 12 dB of lift after the ceiling that exists to bound the chain. Every quiet-to-loud transition would leave residual lift on material already at -1 dBFS, and the render shears that flat. A ceiling with something added after it is not a ceiling. Falsified by reverting to append. WIRING: "Even Out Levels" sits beside "Tone (EQ)" in the add menu, decoding in an OfflineAudioContext and locking the rack while it works, exactly as the carve does. The same control removes it once present, because pressing it twice never means "add a second levelling stage". The stage itself needs no bespoke module — it is a gain node carrying a label and a lane, and the rack already renders that correctly. THE TRAP, now covered: a script hands back a whole HfAutomation describing only its OWN lane, so writing it to the attribute would take the carve's per-band lanes and the track's volume lane with it — silently, totally, and noticed only later when the mix has lost its ducking. `withLane` merges by target instead, and removal takes the orphaned lane with the node. This had no test until the mutation survived; propertyPanelAutomation.test.ts now covers it and fails when withLane replaces the set. Core 1720 -> 1721, studio 3668 -> 3674. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@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