mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-16 22:58:02 +00:00
Rule 1 of `plans/audio-fx-ux/README.md`. A module opens on its name, a line saying what it is for, and the single control that carries it; every other parameter is behind a Details disclosure. Nothing is hidden — it is ordered. `EFFECT_COPY.primary` names that control and `primaryEnds` says what its two ends sound like, which is the question an author actually has: a number tells them where the knob is, not which way to move it. The DSP name moves onto the disclosure itself, so it is read at the moment the author asks what this really is and never before. Ten of the fifteen effects get this. The other five — compressor, gate, saturate, reverb, bitcrush — name their primary as "strength", meaning they want a single DERIVED control over several parameters, which is `PROFILES`, whose figures are proposed rather than measured and which has not shipped. They open on all their controls until it does. That is the honest state: inventing one knob for them now would be a knob that lies about what it sets. The lookup needs no special case for it either — "strength" names no parameter today, and the day it does name one, this starts using it without being told. Worth naming: `peaking`'s primary is "how much", and that only became coherent in the commit before this one. Boosting an unspecified frequency means nothing, so one knob was a lie while the module was generic; now that picking the job is what picks the range, it is the whole truth. The disclosure is local state, keyed by node like the row itself, so it stays with its effect across a reorder — and an effect arriving in the open slot arrives closed, like any other. Tests that address a non-primary knob now open Details first, which is also the gesture a user makes. Falsified: expanding Details unconditionally fails the two-faces test, and dropping the "is it a real parameter" guard fails three. studio 3688 passing, 18 todo.
@hyperframes/studio
Browser-based composition editor UI for Hyperframes. Provides a visual timeline, code editor, and live preview for building video compositions.
Install
npm install @hyperframes/studio
What it does
The studio is a React application with:
- Visual timeline — drag, resize, and arrange elements on tracks
- Code editor — edit HTML and GSAP scripts with CodeMirror (syntax highlighting, autocomplete)
- Live preview — see changes in real time as you edit
- Composition inspector — view and modify element properties
Development
The studio is embedded in the hyperframes preview command. To develop the studio UI itself:
cd packages/studio
bun run dev # Start Vite dev server
bun run build # Build for production
bun run typecheck # Type-check
Tech stack
- React 18/19, Zustand (state management)
- CodeMirror 6 (editor)
- Tailwind CSS (styling)
- Vite (bundler)
- Phosphor Icons
Documentation
Full documentation: hyperframes.heygen.com/packages/studio
Related packages
@hyperframes/core— types and parsers used by the editorhyperframes— CLI that serves the studio viahyperframes preview