API reference
Overview
Every export of every package, generated from the published type definitions.
These pages are generated from the published @miraiclip/* packages: each export's signature and doc comment, plus links to the guides that use it. For how the pieces fit together, start with the guides; come here to look up an exact signature.
| Page | Package | What's in it |
|---|---|---|
| Commands | @miraiclip/core | Every built-in command and its payload fields |
| core | @miraiclip/core | createProject, time and frame helpers, history, patches, captions, AI tools |
| renderer | @miraiclip/renderer | Preview controller, player, browser and worker export, stills, waveform peaks, effect and transition renderers |
| editor | @miraiclip/editor | Timeline maths, clip drag and trim, snapping, transforms, shortcuts, media probing and asset placement |
| react | @miraiclip/react | Providers, hooks and components |
| templates | @miraiclip/templates | Defining, validating, hydrating and batch-rendering templates |
| server-export | @miraiclip/server-export | Exporting from Node |
| assistant | @miraiclip/assistant | The editing assistant and its model adapters |
| mcp | @miraiclip/mcp | The MCP server |
| audio-sources | @miraiclip/audio-sources | Stock and AI-generated audio providers |
Each command's payload is also available at runtime as JSON Schema: project.commandCatalog().