VidStudio SDK reference
    Preparing search index...

    Interface Project

    Top-level container. One project = one editing session.

    interface Project {
        canvas_height?: number;
        canvas_width?: number;
        created_at: number;
        frame_rate?: number;
        id: string;
        loop_playback?: boolean;
        name: string;
        stacking_version?: 2;
        surface?: "orator";
        updated_at: number;
        work_area?: WorkArea;
    }
    Index
    canvas_height? canvas_width? created_at frame_rate? id loop_playback? name stacking_version? surface? updated_at work_area?
    canvas_height?: number
    canvas_width?: number
    created_at: number
    frame_rate?: number
    id: string
    loop_playback?: boolean

    Playback jumps back to the work area's start (or 0) when it reaches the end. Missing = false.

    name: string
    stacking_version?: 2

    2 = visual tracks share one stacking order and text is sorted with them. Missing = the old rule (orders counted per type, text always on top); such a project is renumbered once when it is opened (see stacking-migration.ts).

    surface?: "orator"

    Which surface owns this project. Absent on classic video-editor projects (they predate this field and never set it); 'orator' on projects created by Orator. Orator only ever opens its own projects, so the editor's media never bleeds into the Orator library and vice-versa.

    updated_at: number
    work_area?: WorkArea

    The slice of the timeline being worked on; playback and export can limit to it. Missing = whole timeline.

    Settings
    Member Visibility

    On This Page
    Properties