VidStudio SDK reference
    Preparing search index...

    Interface VidstudioEditorProps

    interface VidstudioEditorProps {
        features?: Partial<EditorFeatures>;
        licence?: { key: string; name: string };
        onClose?: () => void;
        onEvent?: (event: EditorEvent | EditorUiEvent) => void;
        onExport?: (result: ExportResult, file: File) => void;
        onOpenDocument?: OpenDocumentHandler;
        onSaveDocument?: SaveDocumentHandler;
        options?: EngineOptions;
        projectId: string;
        shortcuts?: EditorShortcuts;
        store: ModelStore;
        theme?: Partial<EditorTheme>;
    }
    Index
    features? licence? onClose? onEvent? onExport? onOpenDocument? onSaveDocument? options? projectId shortcuts? store theme?
    features?: Partial<EditorFeatures>
    licence?: { key: string; name: string }

    Checked once against the page's domain; without a licence that covers it the picture carries a watermark.

    onClose?: () => void

    Shows a Close button; the host decides what leaving means.

    onEvent?: (event: EditorEvent | EditorUiEvent) => void

    Every backend event, plus the facts only the user interface knows (a download, a released export).

    onExport?: (result: ExportResult, file: File) => void

    Replaces the browser download. The file is deleted when the export dialog closes, so copy or upload it first.

    onOpenDocument?: OpenDocumentHandler

    Replaces the "Open project" zip picker: return the document and a resolver for its media, or null.

    onSaveDocument?: SaveDocumentHandler

    Replaces the "Save project" zip download: gets the document and one entry per media file, whose read() is a handle to the stored file (upload it, or skip it by its hash).

    options?: EngineOptions

    A new object rebuilds the editor, so keep it stable.

    projectId: string
    shortcuts?: EditorShortcuts

    "scoped" (default): keys reach the editor only while focus is inside it. "global": any key on the page.

    store: ModelStore

    The host owns the store (see createStore); the editor never creates one.

    theme?: Partial<EditorTheme>

    Settings
    Member Visibility

    On This Page
    Properties