@hyperframes/producer

@hyperframes/producer owns the complete render pipeline: compile the project, capture its frames, encode the video, and mix its audio. Use it when rendering is part of your own Node.js service or job runner. For a local script or terminal workflow, use npx hyperframes render instead.

npm install @hyperframes/producer

Render one project

createRenderJob() describes the render. executeRenderJob() receives that job, the project directory, and the output path.

import {
  createRenderJob,
  executeRenderJob,
} from "@hyperframes/producer";

const job = createRenderJob({
  fps: 30,
  quality: "standard",
  format: "mp4",
});

await executeRenderJob(
  job,
  "./my-hyperframes-project",
  "./renders/video.mp4",
  (currentJob, message) => {
    console.log(
      `${Math.round(currentJob.progress)}% ${message}`,
    );
  },
);

The entry file defaults to index.html. Set entryFile when the project has a different entry composition.

const job = createRenderJob({
  fps: { num: 30000, den: 1001 },
  quality: "high",
  entryFile: "compositions/launch.html",
});

Choose an output

Format	Best for	Audio
`mp4`	Default delivery and web playback	AAC
`webm`	Transparent video for the web	Opus
`mov`	Transparent ProRes 4444 for an editor	AAC
`gif`	Small silent previews	None
`png-sequence`	Lossless frames for another pipeline	AAC sidecar when needed
`hls`	VOD streaming from a playlist directory	AAC rendition

HDR output is available for MP4 through hdrMode. Transparent formats render in SDR because HDR and alpha are not one supported output path.

const job = createRenderJob({
  fps: 30,
  quality: "high",
  format: "mp4",
  hdrMode: "auto",
});

See HDR rendering for the source and delivery constraints.

HLS

format: "hls" writes an HLS VOD stream into outputPath, which is a directory: master.m3u8, video.m3u8 and video_NNNNN.ts, plus audio.m3u8 and audio_NNNNN.ts when the composition has audio. The encode is the same H.264 + AAC as MP4 — the packaging pass only stream-copies it into segments.

const job = createRenderJob({
  fps: 30,
  format: "hls",
  hlsSegmentSeconds: 4,
});

Segments are exactly hlsSegmentSeconds long except the last, because the encoder GOP is locked to round(fps × hlsSegmentSeconds) frames so every segment starts on a keyframe. HLS is SDR only (hdrMode: "force-hdr" is rejected), refuses GPU encoding (GPU encoders ignore the keyframe lock), and is not available in distributed rendering, Lambda, or Cloud Run.

Cancel a render

Pass an abort signal to the final argument:

const controller = new AbortController();

await executeRenderJob(
  job,
  "./my-hyperframes-project",
  "./renders/video.mp4",
  undefined,
  controller.signal,
);

// Call controller.abort() from your cancellation path.

An aborted render throws RenderCancelledError. Correctness warnings can also block a render when strictness: "strict" is enabled.

Build a render service

The package exports a Hono application and server helpers:

import { startServer } from "@hyperframes/producer";

await startServer({ port: 8080 });

For larger workloads, the @hyperframes/producer/distributed entry exposes the three rendering activities—plan, renderChunk, and assemble. Your orchestrator remains responsible for dispatch, retries, storage, and networking.

Choose rendering infrastructure

Decide between local, server, Temporal, AWS, or another adapter.

@hyperframes/engine

Use the lower-level capture and encoding primitives.

Start here

Command line

SDK guides

SDK reference

Composition, design & animation

Composition reference

Rendering paths

Cloud infrastructure

Advanced rendering

Packages

Agent setup

Contributing & community

@hyperframes/producer

Render one project

Choose an output

HLS

Cancel a render

Build a render service

Choose rendering infrastructure

@hyperframes/engine

​Render one project

​Choose an output

​HLS

​Cancel a render

​Build a render service

​Related topics

Choose rendering infrastructure

@hyperframes/engine

Render one project

Choose an output

HLS

Cancel a render

Build a render service

Related topics