Skip to main content
This section is for people integrating HyperFrames, automating it, extending the editor, deploying rendering infrastructure, or working directly with composition source. If you only want to create or edit a video, begin with Make your first video or Studio.

Choose the smallest surface

CLI

Create, check, render, publish, and automate projects from a terminal or CI job.

SDK quickstart

Open a composition, query or edit it, persist changes, and build custom editing surfaces.

Player

Embed a seekable HyperFrames composition and control playback from an application.

Packages

Add focused parsing, playback, rendering, Studio, or infrastructure capabilities.

Deployment

Render with managed cloud infrastructure, AWS Lambda, or Google Cloud Run.

HTML schema

Reference composition elements, timing attributes, tracks, variables, and the media contract.

A good first technical result

Choose one result rather than installing the whole repository:
  • render one known project from a script or CI job;
  • open one composition with the SDK and change one value;
  • embed one project with the Player and seek to a timestamp;
  • deploy one minimal render path;
  • validate one generated composition against the schema.
Continue to package or reference pages only when that working path requires more control. Most integrations should not depend on every HyperFrames package.

Working on HyperFrames itself?

Use Contributing for repository setup, tests, Catalog contributions, and releases. Product integrations should begin with one of the surfaces above instead.