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
| Reference | What you will find |
|---|---|
| Command line | Authoring, inspection, revision and export commands |
| Offline documentation | Search exact symbols and task guides, then read bounded source text |
| Project API | Create projects and edit artwork through handles |
| Production API | Timeline, camera, audio, components and production operations |
| Drawing API | Paths, brush resources, pixels, math and geometry |
| Rendering API | Frames, sheets, movies and delivery verification |
| Storage API | Saved projects, partial reads and named revisions |
| Types | Arguments, 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
| Task | Reference |
|---|---|
| Find a layer or element | Object queries |
| Read saved metadata | Storage queries |
| Inspect timeline records | Timeline queries |
| Inspect drawings and holds | Drawing queries |
| Commit an edit that can be retried safely | Edit plans |
| Prepare shot, editorial or audio commands | Shot plans |
| Convert between frame and sample clocks | Time conversion, audio rounding |
| Check files and embedded media | Storage integrity |
| Diagnose a rejected operation | Errors, troubleshooting |
Use the reference that matches your installed engine. codeboard --version identifies it; codeboard capabilities lists the available operations and their constraints.
Codeboard by Nonom Friedman
Explore Nonom Library