storysplat-viewer 2.2.6 → 2.2.9

package/dist/types/dynamic-viewer/FrameSequencePlayer.d.ts

@@ -0,0 +1,87 @@
+/**
+ * FrameSequencePlayer - 4DGS Frame-by-Frame Playback
+ *
+ * Handles loading and playing back sequences of PLY/SOG splat files
+ * for volumetric video (4D Gaussian Splatting) playback.
+ */
+import * as pc from 'playcanvas';
+export interface FrameSequenceConfig {
+    frameUrls: string[];
+    fps?: number;
+    loop?: boolean;
+    preloadCount?: number;
+    autoplay?: boolean;
+}
+export interface FrameSequencePlayerOptions {
+    onFrameChange?: (frame: number, total: number) => void;
+    onLoadProgress?: (loaded: number, total: number) => void;
+    onError?: (error: string) => void;
+}
+type FramePlayerEventCallback = (...args: any[]) => void;
+export declare class FrameSequencePlayer {
+    private options;
+    private app;
+    private frameUrls;
+    private frameAssets;
+    private entities;
+    private activeEntityIndex;
+    private currentFrame;
+    private fps;
+    private isPlaying;
+    private loop;
+    private preloadCount;
+    private lastFrameTime;
+    private frameInterval;
+    private loadingFrames;
+    private destroyed;
+    private listeners;
+    constructor(app: pc.Application, config: FrameSequenceConfig, options?: FrameSequencePlayerOptions);
+    private createSplatEntity;
+    /**
+     * Preload initial frames for smooth playback start
+     */
+    private preloadInitialFrames;
+    /**
+     * Preload a specific frame
+     */
+    preloadFrame(index: number): Promise<pc.Asset | null>;
+    /**
+     * Unload a frame to free memory
+     */
+    unloadFrame(index: number): void;
+    /**
+     * Update the preload window based on current frame
+     */
+    private updatePreloadWindow;
+    /**
+     * Display a specific frame using double-buffering
+     */
+    private displayFrame;
+    /**
+     * Main update loop - called every frame
+     */
+    update(dt: number): void;
+    play(): void;
+    pause(): void;
+    stop(): void;
+    setFrame(index: number): void;
+    nextFrame(): void;
+    previousFrame(): void;
+    getCurrentFrame(): number;
+    getTotalFrames(): number;
+    getProgress(): number;
+    setProgress(progress: number): void;
+    getFps(): number;
+    setFps(fps: number): void;
+    getIsPlaying(): boolean;
+    setLoop(loop: boolean): void;
+    getLoop(): boolean;
+    setPosition(x: number, y: number, z: number): void;
+    setRotation(x: number, y: number, z: number): void;
+    setScale(x: number, y: number, z: number): void;
+    on(event: string, callback: FramePlayerEventCallback): void;
+    off(event: string, callback: FramePlayerEventCallback): void;
+    private emit;
+    destroy(): void;
+}
+export {};

package/dist/types/index.d.ts

@@ -15,6 +15,8 @@ export { generateHTML, generateHTMLFromUrl } from './html-generation/generateHTM
 export type { GenerateHTMLOptions } from './html-generation/generateHTML';
 export { createViewer, createViewerFromUrl } from './dynamic-viewer/createViewer';
 export { createViewerFromSceneId, fetchSceneMeta, SceneNotFoundError, SceneApiError } from './dynamic-viewer/createViewerFromSceneId';
+export { FrameSequencePlayer } from './dynamic-viewer/FrameSequencePlayer';
+export type { FrameSequenceConfig, FrameSequencePlayerOptions } from './dynamic-viewer/FrameSequencePlayer';
 export { transformSceneToExportProps, exportPropsToViewerConfig } from './transformers/sceneToConfig';
 export type { ExportProps, TemplateType, SceneData, WaypointData, HotspotData, ViewerInstance, ViewerOptions, ViewerEvent, ViewerFromSceneIdOptions } from './types';
 export type { RevealPreset, RevealPresetConfig } from './effects';

package/dist/types/types/index.d.ts

@@ -3,6 +3,7 @@
  */
 export type { ViewerConfig } from '../transformers/sceneToConfig';
 export type { ViewerFromSceneIdOptions } from '../dynamic-viewer/createViewerFromSceneId';
+export type { FrameSequenceConfig, FrameSequencePlayerOptions } from '../dynamic-viewer/FrameSequencePlayer';
 /**
  * HTML Mesh configuration (renders HTML as 3D texture)
  */
@@ -414,6 +415,14 @@ export interface SceneData {
     additionalSplats?: SplatSwapPoint[];
     /** Keep preloaded splats in memory (true = hide/show, false = dispose/reload) */
     keepMeshesInMemory?: boolean;
+    /** Frame sequence configuration for 4DGS playback */
+    frameSequence?: {
+        frameUrls: string[];
+        fps?: number;
+        loop?: boolean;
+        preloadCount?: number;
+        autoplay?: boolean;
+    };
 }
 /**
  * Splat swap point - defines when to swap to a different splat during navigation
@@ -668,6 +677,13 @@ export interface ViewerInstance {
     pause: () => void;
     stop: () => void;
     isPlaying: () => boolean;
+    setFrame?: (index: number) => void;
+    getCurrentFrame?: () => number;
+    getTotalFrames?: () => number;
+    setFps?: (fps: number) => void;
+    getFps?: () => number;
+    getFrameProgress?: () => number;
+    setFrameProgress?: (progress: number) => void;
     destroy: () => void;
     resize: () => void;
     navigateToScene: (sceneId: string) => Promise<void>;
@@ -694,7 +710,7 @@ export interface ViewerOptions {
 /**
  * Events emitted by viewer
  */
-export type ViewerEvent = 'ready' | 'waypointChange' | 'playbackStart' | 'playbackStop' | 'error' | 'loaded' | 'progress' | 'warning' | 'portalActivated';
+export type ViewerEvent = 'ready' | 'waypointChange' | 'playbackStart' | 'playbackStop' | 'error' | 'loaded' | 'progress' | 'warning' | 'portalActivated' | 'frameChange' | 'frameComplete';
 /**
  * Warning event data structure
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "storysplat-viewer",
-  "version": "2.2.6",
+  "version": "2.2.9",
   "description": "PlayCanvas-based 3D viewer for StorySplat scenes - HTML export & dynamic embedding",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",