Codeboard.
Technical reference

Technical reference

Use this section when you need an exact command, function signature, data shape or failure contract. For a first project, follow your first drawing; for the object hierarchy and units, read the project model.

Commands and API

ReferenceWhat you will find
Command lineAuthoring, inspection, revision and export commands
Offline documentationSearch exact symbols and task guides, then read bounded source text
Project APICreate projects and edit artwork through handles
Production APITimeline, camera, audio, components and production operations
Drawing APIPaths, brush resources, pixels, math and geometry
Rendering APIFrames, sheets, movies and delivery verification
Storage APISaved projects, partial reads and named revisions
TypesArguments, returned values and stored data shapes

Import named exports from codeboard-studio. API signatures show the callable contract; guide examples show how to combine calls into a task. In a signature, ? marks an optional argument and a value after = is its default.

Automate inspection and revision

TaskReference
Find a layer or elementObject queries
Read saved metadataStorage queries
Inspect timeline recordsTimeline queries
Inspect drawings and holdsDrawing queries
Commit an edit that can be retried safelyEdit plans
Prepare shot, editorial or audio commandsShot plans
Convert between frame and sample clocksTime conversion, audio rounding
Check files and embedded mediaStorage integrity
Diagnose a rejected operationErrors, troubleshooting

Use the reference that matches your installed engine. codeboard --version identifies it; codeboard capabilities lists the available operations and their constraints.

On this page