VidStudio SDK reference
    Preparing search index...

    Interface EngineOptions

    What a host tells the engine instead of the engine reading the page it is on.

    interface EngineOptions {
        assets?: { fonts?: string; models?: string };
        decodeTuning?: Partial<DecodeTuning>;
        exportInWorker?: boolean;
        importTier2?: boolean;
        licence?: Licence;
        namespace?: string;
        renderer?: "pixi" | "canvas2d";
        services?: EngineServices;
    }
    Index
    assets? decodeTuning? exportInWorker? importTier2? licence? namespace? renderer? services?
    assets?: { fonts?: string; models?: string }

    Folders (ending in "/") that serve the font files and the model files. Default "/fonts/" and "/models/".

    decodeTuning?: Partial<DecodeTuning>

    Decode experiments; default none.

    exportInWorker?: boolean

    Default true: exports run in a worker so a hidden tab cannot throttle them.

    importTier2?: boolean

    Default true: the mediabunny import path for files mp4box cannot read.

    licence?: Licence

    Checked once in EditorBackendImpl.open() by checkPageLicence, against the page's host name. That read of location.hostname is the one place the engine reads the page: a licence is bound to the domain the editor is served from, which only the page knows. Without a licence that covers the host, the picture carries a watermark.

    namespace?: string

    Names this instance's database, file root and saved preferences. Default "vidstudio", which keeps the names vidstudio.app has always used.

    renderer?: "pixi" | "canvas2d"

    Default "pixi" (WebGL); "canvas2d" is the fallback renderer.

    services?: EngineServices

    Settings
    Member Visibility

    On This Page
    Properties