@shotstack/shotstack-studio 2.11.3 → 2.11.5

package/dist/index.d.ts

@@ -48,12 +48,28 @@ export declare class Canvas {
     setZoom(zoom: number): void;
     getZoom(): number;
     /**
-     * Capture the current canvas content as a base64-encoded data URL.
+     * Capture the rendered output frame as a base64-encoded data URL.
+     *
+     * Renders the composition full-bleed at the edit's output resolution, independent of the
+     * editor's current zoom and pan — the rendered frame only, without the surrounding canvas
+     * margin, selection handles, or alignment guides. Use {@link captureViewport} to capture
+     * the on-screen editor view instead.
      */
     captureFrame(options?: {
         format?: "png" | "jpeg" | "webp";
         quality?: number;
     }): Promise<string>;
+    /**
+     * Capture the on-screen editor viewport as a base64-encoded data URL.
+     *
+     * Reflects the editor's current zoom, pan, and surrounding canvas — what the user sees.
+     * Use {@link captureFrame} for the full-bleed rendered output frame.
+     */
+    captureViewport(options?: {
+        format?: "png" | "jpeg" | "webp";
+        quality?: number;
+    }): Promise<string>;
+    private extractBase64;
     /**
      * Sync overlay container and toolbar positions after content transforms change.
      * Single point of update for all position-dependent UI elements.
@@ -304,13 +320,33 @@ export declare class Edit {
     getOutputResolution(): string | undefined;
     setOutputAspectRatio(aspectRatio: string): Promise<void>;
     /**
-     * Capture the current canvas as a base64 data URL.
+     * Capture the rendered output frame as a base64 data URL.
+     *
+     * Full-bleed at the edit's output resolution, independent of the editor's zoom and pan. Pass
+     * `time` to capture a specific playhead position. Use {@link captureViewport} for the
+     * on-screen editor view.
      */
     captureFrame(options?: {
         time?: number;
         format?: "png" | "jpeg" | "webp";
         quality?: number;
     }): Promise<string>;
+    /**
+     * Capture the on-screen editor viewport as a base64 data URL.
+     *
+     * Reflects the editor's current zoom, pan, and surrounding canvas. Pass `time` to capture a
+     * specific playhead position. Use {@link captureFrame} for the full-bleed output frame.
+     */
+    captureViewport(options?: {
+        time?: number;
+        format?: "png" | "jpeg" | "webp";
+        quality?: number;
+    }): Promise<string>;
+    /**
+     * Seek (when `time` is given), project html5 video frames into the scene, run `capture`, then
+     * release the static-render state. Shared by {@link captureFrame} and {@link captureViewport}.
+     */
+    private captureStatic;
     /**
      * Atomically apply multiple output settings.
      */
@@ -793,7 +829,6 @@ export declare class VideoExporter {
     private prepareConfig;
     private saveEditState;
     private restoreEditState;
-    private isVideoPlayer;
 }
 
 export { }

package/dist/internal.d.ts

@@ -209,13 +209,33 @@ export declare class Edit {
     getOutputResolution(): string | undefined;
     setOutputAspectRatio(aspectRatio: string): Promise<void>;
     /**
-     * Capture the current canvas as a base64 data URL.
+     * Capture the rendered output frame as a base64 data URL.
+     *
+     * Full-bleed at the edit's output resolution, independent of the editor's zoom and pan. Pass
+     * `time` to capture a specific playhead position. Use {@link captureViewport} for the
+     * on-screen editor view.
      */
     captureFrame(options?: {
         time?: number;
         format?: "png" | "jpeg" | "webp";
         quality?: number;
     }): Promise<string>;
+    /**
+     * Capture the on-screen editor viewport as a base64 data URL.
+     *
+     * Reflects the editor's current zoom, pan, and surrounding canvas. Pass `time` to capture a
+     * specific playhead position. Use {@link captureFrame} for the full-bleed output frame.
+     */
+    captureViewport(options?: {
+        time?: number;
+        format?: "png" | "jpeg" | "webp";
+        quality?: number;
+    }): Promise<string>;
+    /**
+     * Seek (when `time` is given), project html5 video frames into the scene, run `capture`, then
+     * release the static-render state. Shared by {@link captureFrame} and {@link captureViewport}.
+     */
+    private captureStatic;
     /**
      * Atomically apply multiple output settings.
      */