mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-16 06:19:21 +00:00
Adds the property-panel UI for attaching a VST effect chain to an <audio> element (Task 11 of the VST plugin support plan): - packages/core/src/editing/affordances.ts: resolveEditingSections gains vstFx (true only for facts.tag === "audio"), narrower than the existing media flag. - packages/studio/src/utils/vstChainFile.ts: ChainFileJson/ChainPluginJson types + parseChainFile/serializeChainFile for the on-disk .vstchain.json contract shared with the Python sidecar. - packages/studio/src/components/editor/propertyPanelVstSection.tsx: new VstSection component + the VstHostApi interface Task 12's useVstHost will implement. Renders an install hint when vstHost is null; otherwise lets a user add an effect (writes fx/<elementId>.vstchain.json via the existing files PUT endpoint, then commits data-vst-chain via onSetAttribute), list chain plugins, remove one, and open a plugin's editor. - Wired into PropertyPanel.tsx gated on sections.vstFx, with an optional vstHost prop (defaults to null) on PropertyPanelProps for Task 12 to fill in. Co-Authored-By: Claude Sonnet 5 <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