VidStudio SDK reference
    Preparing search index...

    Interface ProjectDocument

    A whole project as one plain JSON object.

    Ids inside a document only mean something within that document: they tie clips to tracks and assets, effects to clips, and so on. loadProject always mints new ids and remaps every reference.

    Orator rows (transcripts, segments, caption config) are not part of a document in v1.

    interface ProjectDocument {
        clips: Clip[];
        effects: DocumentEffect[];
        keyframes: Keyframe[];
        mediaAssets: Omit<MediaAsset, "project_id">[];
        project: Omit<Project, "id" | "created_at" | "updated_at">;
        tracks: Omit<Track, "project_id">[];
        transitions: Transition[];
        version: 1;
    }
    Index
    clips effects keyframes mediaAssets project tracks transitions version
    clips: Clip[]
    effects: DocumentEffect[]
    keyframes: Keyframe[]
    mediaAssets: Omit<MediaAsset, "project_id">[]
    project: Omit<Project, "id" | "created_at" | "updated_at">
    tracks: Omit<Track, "project_id">[]
    transitions: Transition[]
    version: 1

    Settings
    Member Visibility

    On This Page
    Properties