storysplat-viewer 2.3.0 → 2.3.2

package/dist/types/html-generation/generateHTML.d.ts

@@ -19,6 +19,10 @@ export interface GenerateHTMLOptions {
     customCSS?: string;
     /** Whether to minify the output */
     minify?: boolean;
+    /** Enable lazy loading - shows thumbnail with start button before loading (overrides scene data) */
+    lazyLoad?: boolean;
+    /** Custom button text for lazy loading (overrides scene data) */
+    lazyLoadButtonText?: string;
 }
 /**
  * Generate standalone HTML for a StorySplat scene

package/dist/types/transformers/sceneToConfig.d.ts

@@ -73,6 +73,7 @@ export interface ViewerConfig {
     xrMode?: 'ar' | 'vr' | 'both';
     customScript?: string;
     backgroundColor?: string;
+    audioEmitters?: any[];
 }
 /**
  * Transform ExportProps to scene config for dynamic viewer

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

@@ -1,6 +1,8 @@
 /**
  * StorySplat Viewer Types
  */
+/** Special URL value indicating "return to original splat" */
+export declare const ORIGINAL_SPLAT_URL = "__ORIGINAL__";
 export type { ViewerConfig } from '../transformers/sceneToConfig';
 export type { ViewerFromSceneIdOptions } from '../dynamic-viewer/createViewerFromSceneId';
 export type { FrameSequenceConfig, FrameSequencePlayerOptions } from '../dynamic-viewer/FrameSequencePlayer';
@@ -387,6 +389,10 @@ export interface SceneData {
         buttonLabels?: ButtonLabels;
         /** Custom preloader logo URL for whitelabeling */
         customPreloaderLogoUrl?: string;
+        /** Enable lazy loading - shows thumbnail with start button before loading */
+        lazyLoad?: boolean;
+        /** Custom button text for lazy loading. Default: "Start Experience" */
+        lazyLoadButtonText?: string;
     };
     defaultCameraMode?: 'first-person' | 'orbit' | 'drone';
     allowedCameraModes?: string[];
@@ -415,6 +421,8 @@ export interface SceneData {
     additionalSplats?: SplatSwapPoint[];
     /** Keep preloaded splats in memory (true = hide/show, false = dispose/reload) */
     keepMeshesInMemory?: boolean;
+    /** Standalone spatial audio sources in the scene */
+    audioEmitters?: AudioEmitterConfig[];
     /** Frame sequence configuration for 4DGS playback */
     frameSequence?: {
         frameUrls: string[];
@@ -589,6 +597,8 @@ export interface HotspotData {
     fontSize?: number;
     /** Popup font family */
     fontFamily?: string;
+    /** Popup close button color (hex) */
+    closeButtonColor?: string;
 }
 /**
  * Portal data structure - links to another StorySplat scene
@@ -684,6 +694,12 @@ export interface ViewerInstance {
     getFps?: () => number;
     getFrameProgress?: () => number;
     setFrameProgress?: (progress: number) => void;
+    /** Switch back to the original/initial splat */
+    goToOriginalSplat: () => void;
+    /** Get the URL of the currently displayed splat */
+    getCurrentSplatUrl: () => string;
+    /** Check if currently showing the original splat */
+    isShowingOriginalSplat: () => boolean;
     destroy: () => void;
     resize: () => void;
     navigateToScene: (sceneId: string) => Promise<void>;
@@ -710,7 +726,7 @@ export interface ViewerOptions {
 /**
  * Events emitted by viewer
  */
-export type ViewerEvent = 'ready' | 'waypointChange' | 'playbackStart' | 'playbackStop' | 'error' | 'loaded' | 'progress' | 'warning' | 'portalActivated' | 'frameChange' | 'frameComplete';
+export type ViewerEvent = 'ready' | 'waypointChange' | 'playbackStart' | 'playbackStop' | 'error' | 'loaded' | 'progress' | 'warning' | 'portalActivated' | 'frameChange' | 'frameComplete' | 'splatChange';
 /**
  * Warning event data structure
  */
@@ -720,3 +736,36 @@ export interface ViewerWarning {
     details?: string;
     url?: string;
 }
+/**
+ * Audio emitter configuration - standalone spatial audio sources
+ */
+export interface AudioEmitterConfig {
+    id: string;
+    name?: string;
+    /** URL to the audio file */
+    url: string;
+    /** Position in world space */
+    position: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    /** Volume (0-1) */
+    volume?: number;
+    /** Loop playback */
+    loop?: boolean;
+    /** Auto-play when scene loads */
+    autoplay?: boolean;
+    /** Use 3D spatial audio */
+    spatialSound?: boolean;
+    /** Distance model for spatial audio */
+    distanceModel?: 'linear' | 'inverse' | 'exponential';
+    /** Maximum distance for spatial audio */
+    maxDistance?: number;
+    /** Reference distance for spatial audio */
+    refDistance?: number;
+    /** Rolloff factor for spatial audio */
+    rolloffFactor?: number;
+    /** Whether the emitter is enabled */
+    enabled?: boolean;
+}

package/package.json

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