@shotstack/shotstack-studio 2.10.1 → 2.11.0

package/dist/index.d.ts

@@ -47,6 +47,13 @@ export declare class Canvas {
     resize(): void;
     setZoom(zoom: number): void;
     getZoom(): number;
+    /**
+     * Capture the current canvas content as a base64-encoded data URL.
+     */
+    captureFrame(options?: {
+        format?: "png" | "jpeg" | "webp";
+        quality?: number;
+    }): Promise<string>;
     /**
      * Sync overlay container and toolbar positions after content transforms change.
      * Single point of update for all position-dependent UI elements.
@@ -155,8 +162,37 @@ export declare class Edit {
      */
     loadEdit(edit: Edit_2): Promise<void>;
     private loadSoundtrack;
-    getEdit(): Edit_2;
-    addClip(trackIdx: number, clip: Clip): void | Promise<void>;
+    /**
+     * Serialise the current edit to plain JSON.
+     */
+    getEdit(options?: {
+        includeIds?: boolean;
+    }): Edit_2;
+    /**
+     * Look up a clip by its stable ID.
+     * @returns The clip or null if no clip with that ID exists.
+     */
+    getClipById(clipId: string): Clip | null;
+    /**
+     * Look up the (trackIndex, clipIndex) position of a clip by its stable ID.
+     */
+    getClipPositionById(clipId: string): {
+        trackIndex: number;
+        clipIndex: number;
+    } | null;
+    /**
+     * Patch fields on a clip identified by stable ID.
+     */
+    updateClipById(clipId: string, updates: Partial<Clip>): Promise<void>;
+    /**
+     * Remove a clip identified by stable ID.
+     */
+    deleteClipById(clipId: string): Promise<void>;
+    /**
+     * Move a clip identified by stable ID to a different track and/or start time.
+     */
+    moveClipById(clipId: string, toTrackIndex: number, newStart?: Seconds): Promise<void>;
+    addClip(trackIdx: number, clip: Clip): Promise<void>;
     addSvgClip(svgMarkup: string, opts?: {
         trackIndex?: number;
         start?: Seconds;
@@ -183,6 +219,16 @@ export declare class Edit {
     canDeleteClip(trackIdx: number, clipIdx: number): boolean;
     deleteClip(trackIdx: number, clipIdx: number): Promise<void>;
     addTrack(trackIdx: number, track: Track): Promise<void>;
+    /**
+     * Add a font to the timeline.
+     */
+    addFont(src: string): Promise<void>;
+    /**
+     * Replace timeline fonts wholesale.
+     */
+    setFonts(fonts: Array<{
+        src: string;
+    }>): Promise<void>;
     /**
      * Auto-link rich-caption clips to the first eligible source clip.
      * If an alias reference in the caption's src can't be resolved, link it automatically.
@@ -197,6 +243,10 @@ export declare class Edit {
      */
     private addCommandToHistory;
     updateClip(trackIdx: number, clipIdx: number, updates: Partial<Clip>): Promise<void>;
+    /**
+     * HEAD-check every external http(s) URL in a payload
+     */
+    private preflightAssetUrls;
     /**
      * Handle command result - only add to history if successful.
      */
@@ -253,6 +303,27 @@ export declare class Edit {
     setOutputResolution(resolution: string): Promise<void>;
     getOutputResolution(): string | undefined;
     setOutputAspectRatio(aspectRatio: string): Promise<void>;
+    /**
+     * Capture the current canvas as a base64 data URL.
+     */
+    captureFrame(options?: {
+        time?: number;
+        format?: "png" | "jpeg" | "webp";
+        quality?: number;
+    }): Promise<string>;
+    /**
+     * Atomically apply multiple output settings.
+     */
+    setOutput(options: {
+        size?: {
+            width: number;
+            height: number;
+        };
+        resolution?: string;
+        format?: string;
+        fps?: number;
+        aspectRatio?: string;
+    }): Promise<void>;
     getOutputAspectRatio(): string | undefined;
     setTimelineBackground(color: string): Promise<void>;
     private setTimelineBackgroundInternal;

package/dist/internal.d.ts

@@ -67,8 +67,37 @@ export declare class Edit {
      */
     loadEdit(edit: Edit_2): Promise<void>;
     private loadSoundtrack;
-    getEdit(): Edit_2;
-    addClip(trackIdx: number, clip: Clip): void | Promise<void>;
+    /**
+     * Serialise the current edit to plain JSON.
+     */
+    getEdit(options?: {
+        includeIds?: boolean;
+    }): Edit_2;
+    /**
+     * Look up a clip by its stable ID.
+     * @returns The clip or null if no clip with that ID exists.
+     */
+    getClipById(clipId: string): Clip | null;
+    /**
+     * Look up the (trackIndex, clipIndex) position of a clip by its stable ID.
+     */
+    getClipPositionById(clipId: string): {
+        trackIndex: number;
+        clipIndex: number;
+    } | null;
+    /**
+     * Patch fields on a clip identified by stable ID.
+     */
+    updateClipById(clipId: string, updates: Partial<Clip>): Promise<void>;
+    /**
+     * Remove a clip identified by stable ID.
+     */
+    deleteClipById(clipId: string): Promise<void>;
+    /**
+     * Move a clip identified by stable ID to a different track and/or start time.
+     */
+    moveClipById(clipId: string, toTrackIndex: number, newStart?: Seconds): Promise<void>;
+    addClip(trackIdx: number, clip: Clip): Promise<void>;
     addSvgClip(svgMarkup: string, opts?: {
         trackIndex?: number;
         start?: Seconds;
@@ -95,6 +124,16 @@ export declare class Edit {
     canDeleteClip(trackIdx: number, clipIdx: number): boolean;
     deleteClip(trackIdx: number, clipIdx: number): Promise<void>;
     addTrack(trackIdx: number, track: Track): Promise<void>;
+    /**
+     * Add a font to the timeline.
+     */
+    addFont(src: string): Promise<void>;
+    /**
+     * Replace timeline fonts wholesale.
+     */
+    setFonts(fonts: Array<{
+        src: string;
+    }>): Promise<void>;
     /**
      * Auto-link rich-caption clips to the first eligible source clip.
      * If an alias reference in the caption's src can't be resolved, link it automatically.
@@ -109,6 +148,10 @@ export declare class Edit {
      */
     private addCommandToHistory;
     updateClip(trackIdx: number, clipIdx: number, updates: Partial<Clip>): Promise<void>;
+    /**
+     * HEAD-check every external http(s) URL in a payload
+     */
+    private preflightAssetUrls;
     /**
      * Handle command result - only add to history if successful.
      */
@@ -165,6 +208,27 @@ export declare class Edit {
     setOutputResolution(resolution: string): Promise<void>;
     getOutputResolution(): string | undefined;
     setOutputAspectRatio(aspectRatio: string): Promise<void>;
+    /**
+     * Capture the current canvas as a base64 data URL.
+     */
+    captureFrame(options?: {
+        time?: number;
+        format?: "png" | "jpeg" | "webp";
+        quality?: number;
+    }): Promise<string>;
+    /**
+     * Atomically apply multiple output settings.
+     */
+    setOutput(options: {
+        size?: {
+            width: number;
+            height: number;
+        };
+        resolution?: string;
+        format?: string;
+        fps?: number;
+        aspectRatio?: string;
+    }): Promise<void>;
     getOutputAspectRatio(): string | undefined;
     setTimelineBackground(color: string): Promise<void>;
     private setTimelineBackgroundInternal;
@@ -313,6 +377,18 @@ declare class EventEmitter<TEventPayloadMap extends EventPayloadMap = EventPaylo
 
 declare type EventPayloadMap<TPayload = any> = Record<string, TPayload>;
 
+/**
+ * Thrown by mutation methods (addClip, addTrack, addFont, setFonts) when a
+ * referenced asset/font URL fails preflight.
+ */
+export declare class InvalidAssetUrlError extends Error {
+    readonly code: "INVALID_ASSET_URL";
+    readonly url: string;
+    readonly status: number | undefined;
+    readonly reason: string;
+    constructor(url: string, status: number | undefined, reason: string);
+}
+
 declare type Listener<TPayload = any> = (payload: TPayload) => void;
 
 /**