You will learn#
- how to create a project with a format that fits the platform;
- how to list and read projects;
- what the revision number means.
The idea#
A project is one JSON document: tracks, items, the assets it uses and its settings. Every change is a batch of operations that raises its revision by one, so a project always has a clean history you can undo.
Quick start#
vukem-video project:create --name "Launch teaser" --preset 9:16 --json
vukem-video project:list --json
vukem-video project:show prj_7k2m9x4q1bCall project_create with {"name": "Launch teaser", "preset": "9:16"}, then project_list and project_get.
POST /api/v1/projects with {"name": "Launch teaser"}, then GET /api/v1/projects and GET /api/v1/projects/{id}.
The presets are 9:16 (the default, for short vertical video), 1:1, 16:9 and 4:5. The frame rate defaults to 30 and can be 30000/1001. A new project is at revision 0.
Common mistakes#
- Using a project id from another workspace. A project id looks like
prj_7k2m9x4q1b; an unknown one isE_NOT_FOUND. - Editing a trashed project. Restore it first with
project:restore; the error isE_INVALID_STATE.