mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-04 13:07:11 +00:00
tai (bot)andClaude Opus 4.7
ef13428d26
Resolves conflicts in packages/player/src/hyperframes-player.ts introduced by main's LOC-split refactor (PR #750), which extracted DirectTimelineClock + ParentMediaManager into separate modules. The PR's parent-tick-clock additions are re-applied on top of the refactored class structure: - New `_parentTickRaf` field - New `_startParentTickClock` / `_stopParentTickClock` private methods (placed alongside `_sendControl`, since the tick uses postMessage) - `_stopParentTickClock()` call added to `disconnectedCallback`, `pause`, `seek`, and `_onIframeLoad` (alongside the existing `this._directTimelineClock.stop()` calls there) - `play()` updated: - `this._paused = false` moved BEFORE `_startParentTickClock` so the RAF tick's `_paused` check doesn't self-terminate on first callback - `_startParentTickClock()` only fires on the runtime-bridge path (`!directTimelineStarted`) AND when ready + no adapter, matching the second PR commit's review fix No semantic change vs. the pre-refactor PR head — this commit only reconciles the surface differences from #750. Co-Authored-By: Claude Opus 4.7 (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