mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-11 19:09:20 +00:00
Miguel Angel Simon Sierra
3a0049a1cd
primeAnimeInstance() seeks every registered timeline to its full duration and back to 0 at registration time, purely to force lazily-rendered CSS onto elements before the composition's first real seek. anime.js fires tl.call()/onComplete callbacks as a side effect of any seek that crosses their position, including this internal priming seek -- so a composition using tl.call() (or a raw onComplete tween) renders as if it had already reached that callback's end state from frame 0 onward, regardless of the time actually requested later. anime.js's own Timer.prototype.seek(time, muteCallbacks) already suppresses onBegin/onComplete/onUpdate/onLoop/onRender for a given seek; pass true on both priming seeks instead of reimplementing that suppression. Widened RuntimeAnimeInstance.seek to accept the optional second argument. Confirmed against liquid-glass-widgets (a tl.call() status-text swap scheduled at t=5.2s was rendering already-fired at t=1.434s) and flowchart/flowchart-vertical (their addTimelineCall()/onComplete helper had the whole diagram, cursor, and text-correction sequence visible from frame 0). Added a regression test exercising the same tl.call()-during-priming scenario directly against the adapter.
@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