Luxar Viewer API Documentation - v2026.9.22
    Preparing search index...

    Interface ZipFinalizeOptions

    interface ZipFinalizeOptions {
        capturedFrames: number;
        frameExt: string;
        label: string;
        totalBytes: number;
        ffmpegScript: string;
        fallbackDownloadName: string;
        showToast: (msg: string) => void;
        downloadBlob: (blob: Blob, filename: string) => void;
        onPackagingStart?: () => void;
        signal?: AbortSignal;
    }
    Index
    capturedFrames frameExt label totalBytes ffmpegScript fallbackDownloadName showToast downloadBlob onPackagingStart? signal?
    capturedFrames: number

    Frame count actually captured (excludes failures).

    frameExt: string

    Frame extension (e.g. 'png', 'jpg', 'exr') for ffmpeg's input pattern.

    label: string

    Human-readable label for toasts ("PNG", "EXR").

    totalBytes: number

    Total bytes streamed (used in toasts when saving to disk).

    ffmpegScript: string

    ffmpeg script body to attach as encode_video.sh.

    fallbackDownloadName: string

    Suggested filename for the in-memory fallback download.

    showToast: (msg: string) => void

    Show a toast (panel-supplied so this module stays UI-agnostic).

    downloadBlob: (blob: Blob, filename: string) => void

    Download a blob (panel-supplied).

    onPackagingStart?: () => void

    Optional UI hook called before the (potentially slow) finalize step.

    signal?: AbortSignal

    Optional abort signal. If aborted mid-finalize, finalize() routes to internal abort cleanup (end stream, abort writable, drop chunks) and does NOT call showToast / downloadBlob — the panel is responsible for cancel UX.

    Settings
    Member Visibility

    On This Page
    Properties