mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-14 18:01:20 +08:00
Miguel Ángel
764755b23e
Adds a strict sync tier to the runtime-owned media path that catches accumulated drift from repeated pause/play toggling. Previously, drift below 0.5s persisted indefinitely (only the 3s catastrophic valve would correct it). For speech-driven videos where narration, captions, and visual timing need to stay aligned, this caused audible desync. The fix adds three mechanisms: 1. **Strict sync (80ms, consecutive-sample gated)**: when the timeline- to-media offset has stabilized (not growing from initial buffering) and drift exceeds 80ms for 2 consecutive ticks, force a currentTime correction. This mirrors the parent-proxy path's 50ms threshold with consecutive-sample gating (MIRROR_DRIFT_THRESHOLD_SECONDS). 2. **forceSync on transitions**: play/pause toggles, seek, and playback- rate changes set a one-shot flag that forces an immediate sync on the next tick, bypassing all thresholds. This prevents drift from accumulating across pause/play cycles. 3. **Buffering guard**: strict sync only fires when the offset has stabilized (delta < 4ms/tick). During initial buffering, the offset grows ~16ms/tick as the timeline advances while media stays at 0 — this gradual growth is not corrected, preserving the existing behavior of not skipping opening audio. Closes #668 Co-Authored-By: Claude Opus 4.6 (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