@shotstack/shotstack-studio 2.10.0 → 2.10.2

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,7 +162,36 @@ export declare class Edit {
      */
     loadEdit(edit: Edit_2): Promise<void>;
     private loadSoundtrack;
-    getEdit(): Edit_2;
+    /**
+     * 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): void | Promise<void>;
     addSvgClip(svgMarkup: string, opts?: {
         trackIndex?: number;
@@ -253,6 +289,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,7 +67,36 @@ export declare class Edit {
      */
     loadEdit(edit: Edit_2): Promise<void>;
     private loadSoundtrack;
-    getEdit(): Edit_2;
+    /**
+     * 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): void | Promise<void>;
     addSvgClip(svgMarkup: string, opts?: {
         trackIndex?: number;
@@ -165,6 +194,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;