@ericchen1990/pano-view 2.2.2 → 2.4.0

package/dist/index.d.mts

@@ -127,6 +127,25 @@ type PanoramaPointerEvent = {
     clientY: number;
 };
 
+type BackgroundAudioSnapshot = {
+    ready: boolean;
+    playing: boolean;
+    blocked: boolean;
+    ended: boolean;
+    muted: boolean;
+    volume: number;
+};
+type BackgroundAudioController = {
+    subscribe: (onStoreChange: () => void) => () => void;
+    getSnapshot: () => BackgroundAudioSnapshot;
+    play: () => void;
+    pause: () => void;
+    togglePlay: () => void;
+    setVolume: (volume: number) => void;
+    setMuted: (muted: boolean) => void;
+    toggleMuted: () => void;
+};
+
 type KeyboardControlAction = "left" | "right" | "up" | "down" | "zoomIn" | "zoomOut" | "previousScene" | "nextScene" | "reset";
 type KeyboardControlKeys = Partial<Record<KeyboardControlAction, string | readonly string[]>>;
 /** Options for keyboard-driven panorama navigation. */
@@ -173,6 +192,189 @@ declare function cycleSceneId(scenes: readonly {
  */
 declare function KeyboardControls({ enabled, keys, rotateSpeed, zoomSpeed, shiftMultiplier, invert, fovSpeed, onPreviousScene, onNextScene, }: KeyboardControlsProps): null;
 
+type VideoPlaybackState = "playing" | "paused" | "ended" | "blocked";
+type VideoHotspotErrorEvent = {
+    id: string;
+    source: "poster" | "video";
+    error: unknown;
+};
+type VideoHotspotProps = HotspotCommonProps & {
+    src: string;
+    playing: boolean;
+    poster?: string;
+    loop?: boolean;
+    muted?: boolean;
+    volume?: number;
+    playsInline?: boolean;
+    preload?: "none" | "metadata" | "auto";
+    crossOrigin?: "" | "anonymous" | "use-credentials";
+    onPlaybackStateChange?: (state: VideoPlaybackState) => void;
+    onPlaybackError?: (error: unknown) => void;
+    onEnded?: () => void;
+    onError?: (event: VideoHotspotErrorEvent) => void;
+};
+declare function VideoHotspot({ id, src, playing, poster, loop, muted, volume, playsInline, preload, crossOrigin, width, height, opacity, onPlaybackStateChange, onPlaybackError, onEnded, onError, ...anchorProps }: VideoHotspotProps): react.JSX.Element;
+
+type PanoVideoSource = {
+    src: string;
+    type?: string;
+};
+type PanoVideoVariant = {
+    id: string;
+    label: string;
+    poster?: string;
+    sources: readonly PanoVideoSource[];
+};
+type PanoVideoTrackKind = "subtitles" | "captions";
+type PanoVideoTrack = {
+    /** Defaults to `srcLang`. */
+    id?: string;
+    src: string;
+    srcLang: string;
+    label: string;
+    kind?: PanoVideoTrackKind;
+    default?: boolean;
+};
+type PanoVideoCaptionAppearance = {
+    color?: string;
+    background?: string;
+    fontSize?: number | string;
+    fontFamily?: string;
+    fontWeight?: CSSProperties["fontWeight"];
+    textShadow?: string;
+    padding?: string;
+    borderRadius?: number | string;
+    maxWidth?: number | string;
+    bottom?: number | string;
+    lineHeight?: number | string;
+};
+type PanoVideoControlsAppearance = {
+    background?: string;
+    color?: string;
+    accent?: string;
+    borderRadius?: number | string;
+    fontSize?: number | string;
+    padding?: string;
+};
+type PanoVideoErrorSource = "poster" | "video" | "track";
+type PanoVideoErrorEvent = {
+    source: PanoVideoErrorSource;
+    error: unknown;
+};
+type PanoVideoPlaybackSnapshot = {
+    ready: boolean;
+    playing: boolean;
+    blocked: boolean;
+    ended: boolean;
+    currentTime: number;
+    duration: number;
+    volume: number;
+    /** False when the element ignores `volume` (iOS Safari). Mute still works. */
+    volumeAdjustable: boolean;
+    muted: boolean;
+    playbackRate: number;
+    variantId: string;
+    variants: readonly PanoVideoVariant[];
+    trackId: string | null;
+    tracks: readonly PanoVideoTrack[];
+    captionText: string;
+    captionAppearance: Required<PanoVideoCaptionAppearance>;
+    captionsEnabled: boolean;
+    playbackRates: readonly number[];
+    playbackState: VideoPlaybackState;
+};
+type PanoVideoController = {
+    subscribe: (onStoreChange: () => void) => () => void;
+    getSnapshot: () => PanoVideoPlaybackSnapshot;
+    play: () => Promise<void>;
+    pause: () => void;
+    togglePlay: () => void;
+    seek: (time: number) => void;
+    setVolume: (volume: number) => void;
+    setMuted: (muted: boolean) => void;
+    toggleMuted: () => void;
+    setPlaybackRate: (rate: number) => void;
+    setVariantId: (id: string) => void;
+    setTrackId: (id: string | null) => void;
+    setCaptionAppearance: (appearance: Partial<PanoVideoCaptionAppearance>) => void;
+};
+
+type WebVRMode = "webxr" | "mobilevr" | "fake";
+type WebVRProfileId = "none" | "cardboard-v1" | "cardboard-v2" | "gear-vr" | "daydream";
+type WebVRProfile = {
+    id?: string;
+    label?: string;
+    /** Vertical field of view for each eye, in degrees. */
+    fov: number;
+    /** Distance between the eyes, in millimetres. */
+    ipdMm: number;
+    /** Distance from the display to the headset lens, in millimetres. */
+    screenToLensMm?: number;
+    /** Radial lens distortion coefficients. Zero disables distortion. */
+    k1: number;
+    k2: number;
+};
+type WebVRChromeAppearance = {
+    background?: CSSProperties["background"];
+    color?: CSSProperties["color"];
+    accent?: CSSProperties["color"];
+    borderRadius?: CSSProperties["borderRadius"];
+    fontSize?: CSSProperties["fontSize"];
+    setupTitle?: ReactNode;
+};
+type WebVRChrome = boolean | WebVRChromeAppearance;
+type WebVRProps = {
+    /** Mount the built-in Enter / Exit / Setup chrome. Defaults to true. */
+    chrome?: WebVRChrome;
+    /** Enable the phone stereoscopic fallback. Defaults to true. */
+    mobileVr?: boolean;
+    /** Treat desktop device-orientation sensors as MobileVR. Defaults to false. */
+    desktopSupport?: boolean;
+    /** Allow a mouse-driven stereoscopic desktop simulation. Defaults to true. */
+    fakeSupport?: boolean;
+    /** Physical diagonal screen size in inches, or automatic detection. */
+    screensize?: number | "auto";
+    /** Headset preset or a custom lens profile. */
+    profile?: WebVRProfileId | WebVRProfile;
+    /** Show a center reticle in VR. Defaults to true. */
+    cursor?: boolean;
+    /**
+     * Milliseconds to keep looking at a hotspot before a gaze click.
+     * Defaults to 1500. Set to 0 to disable auto-click.
+     */
+    cursorDwellMs?: number;
+    /**
+     * Keep the display awake while MobileVR or simulated VR is active.
+     * Uses the Screen Wake Lock API when available, otherwise a looping
+     * hidden video. Defaults to true.
+     */
+    wakelock?: boolean;
+    /**
+     * Lock the mouse in simulated desktop VR so movement looks around with
+     * no visible cursor. Click the view to re-lock after Escape. Defaults to true.
+     */
+    mousePointerLock?: boolean;
+    onAvailable?: () => void;
+    onUnavailable?: () => void;
+    onEnterVR?: (mode: WebVRMode) => void;
+    onExitVR?: (mode: WebVRMode) => void;
+    onDenied?: (error?: unknown) => void;
+    onUnknownDevice?: () => void;
+};
+type WebVRHandle = {
+    enterVR: () => Promise<boolean>;
+    exitVR: () => Promise<void>;
+    toggleVR: () => Promise<boolean>;
+    isAvailable: () => boolean;
+    isEnabled: () => boolean;
+    getMode: () => WebVRMode | null;
+    requestPermission: () => Promise<boolean>;
+};
+type WebVRSettings = {
+    screensize: number | "auto";
+    profileId: WebVRProfileId;
+};
+
 type PanoViewerState = {
     /** Horizontal look angle in degrees. Positive values look right. */
     yaw: number;
@@ -189,11 +391,44 @@ type PanoViewerHandle = {
     getView: () => PanoViewerState;
     setView: (view: Partial<PanoViewerState>, options?: SetPanoViewerOptions) => void;
     reset: () => void;
+    enterFullscreen: () => Promise<void>;
+    exitFullscreen: () => Promise<void>;
+    toggleFullscreen: () => Promise<void>;
+    isFullscreen: () => boolean;
+    setScene: (id: string) => boolean;
+    nextScene: () => boolean;
+    previousScene: () => boolean;
+    getActiveSceneId: () => string | null;
+    getSceneIds: () => readonly string[];
+    isSceneTransitioning: () => boolean;
+    enterVR: () => Promise<boolean>;
+    exitVR: () => Promise<void>;
+    toggleVR: () => Promise<boolean>;
+    isVRAvailable: () => boolean;
+    isVREnabled: () => boolean;
+    getVRMode: () => WebVRMode | null;
+    requestVRPermission: () => Promise<boolean>;
+    getVideo: () => PanoVideoController | null;
+    subscribeVideo: (onStoreChange: () => void) => () => void;
+    playVideo: () => Promise<void>;
+    pauseVideo: () => void;
+    toggleVideo: () => void;
+    seekVideo: (time: number) => void;
+    setVideoVolume: (volume: number) => void;
+    setVideoMuted: (muted: boolean) => void;
+    toggleVideoMuted: () => void;
+    getBackgroundAudio: () => BackgroundAudioController | null;
+    subscribeBackgroundAudio: (onStoreChange: () => void) => () => void;
+    playBackgroundAudio: () => Promise<void>;
+    pauseBackgroundAudio: () => void;
+    toggleBackgroundAudio: () => void;
+    setBackgroundAudioVolume: (volume: number) => void;
+    setBackgroundAudioMuted: (muted: boolean) => void;
+    toggleBackgroundAudioMuted: () => void;
     /** @deprecated Control an AutoRotate component's enabled prop instead. */
     startAutoRotate: () => void;
     /** @deprecated Control an AutoRotate component's enabled prop instead. */
     stopAutoRotate: () => void;
-    toggleFullscreen: () => Promise<void>;
 };
 type MouseControlButton = "left" | "middle" | "right";
 /** Options for the default mouse control channel (also MouseControls props). */
@@ -519,6 +754,73 @@ type AutoRotateProps = {
  */
 declare function AutoRotate({ enabled, speed, acceleration, startDelay, }: AutoRotateProps): null;
 
+type AudioPlaybackState = "playing" | "paused" | "ended" | "blocked";
+type AudioHotspotErrorEvent = {
+    id: string;
+    error: unknown;
+};
+type AudioHotspotProps = HotspotCommonProps & {
+    src: string | string[];
+    playing: boolean;
+    loop?: boolean;
+    muted?: boolean;
+    volume?: number;
+    /** Degrees of look-away before the source is silent. Defaults to 360 (no look attenuation). */
+    range?: number;
+    pauseWhenHidden?: boolean;
+    /** Optional stopped-state image. When omitted, a built-in speaker icon is used. */
+    icon?: string;
+    /** Optional playing-state image. Falls back to `icon`, then the built-in playing icon. */
+    playingIcon?: string;
+    /** When false, no visual marker is rendered. Audio still plays. Defaults to true. */
+    marker?: boolean;
+    crossOrigin?: "" | "anonymous" | "use-credentials";
+    onPlaybackStateChange?: (state: AudioPlaybackState) => void;
+    onPlaybackError?: (error: unknown) => void;
+    onEnded?: () => void;
+    onError?: (event: AudioHotspotErrorEvent) => void;
+};
+declare function AudioHotspot({ id, src, playing, loop, muted, volume, range, pauseWhenHidden, icon, playingIcon, marker, crossOrigin, width, height, opacity, onPlaybackStateChange, onPlaybackError, onEnded, onError, ...anchorProps }: AudioHotspotProps): react.JSX.Element;
+
+type BackgroundAudioSource = string | readonly string[];
+type BackgroundAudioErrorEvent = {
+    error: unknown;
+};
+type BackgroundAudioProps = {
+    /** Shared tour track when `sources` is omitted, or fallback when a scene has no entry. */
+    src?: BackgroundAudioSource;
+    /** Per-scene tracks keyed by `Scene.id`. Requires `sceneId`. */
+    sources?: Readonly<Record<string, BackgroundAudioSource>>;
+    /** Current scene id. Required when `sources` is set. */
+    sceneId?: string;
+    /**
+     * Controlled playing state. When provided, the parent owns play/pause.
+     * When omitted, the component manages its own state and imperative
+     * `playBackgroundAudio` / `pauseBackgroundAudio` work directly.
+     */
+    playing?: boolean;
+    /** Initial playing state when `playing` is omitted. Defaults to false. */
+    defaultPlaying?: boolean;
+    /** Defaults to true. */
+    loop?: boolean;
+    muted?: boolean;
+    volume?: number;
+    pauseWhenHidden?: boolean;
+    /** Crossfade duration when the resolved track changes. Defaults to 400; 0 is a hard cut. */
+    fadeMs?: number;
+    crossOrigin?: "" | "anonymous" | "use-credentials";
+    onPlaybackStateChange?: (state: AudioPlaybackState) => void;
+    onPlaybackError?: (error: unknown) => void;
+    onEnded?: () => void;
+    onError?: (event: BackgroundAudioErrorEvent) => void;
+};
+/**
+ * Adds a non-spatial soundtrack to the nearest PanoViewer. Render one instance
+ * as a child of PanoViewer, alongside Scenes or a panorama source — not inside
+ * renderHotspots.
+ */
+declare function BackgroundAudio({ src, sources, sceneId, playing: controlledPlaying, defaultPlaying, loop, muted, volume, pauseWhenHidden, fadeMs, crossOrigin, onPlaybackStateChange, onPlaybackError, onEnded, onError, }: BackgroundAudioProps): null;
+
 declare const PANO_FILTER_PRESETS: readonly ["none", "grayscale", "sepia", "vintage", "cool", "warm", "pencil", "coloredPencil", "crayon", "watercolor", "cartoon", "crosshatch"];
 type PanoFilterPreset = (typeof PANO_FILTER_PRESETS)[number];
 
@@ -578,82 +880,6 @@ type GyroProps = {
  */
 declare const Gyro: react.ForwardRefExoticComponent<GyroProps & react.RefAttributes<GyroHandle>>;
 
-type WebVRMode = "webxr" | "mobilevr" | "fake";
-type WebVRProfileId = "none" | "cardboard-v1" | "cardboard-v2" | "gear-vr" | "daydream";
-type WebVRProfile = {
-    id?: string;
-    label?: string;
-    /** Vertical field of view for each eye, in degrees. */
-    fov: number;
-    /** Distance between the eyes, in millimetres. */
-    ipdMm: number;
-    /** Distance from the display to the headset lens, in millimetres. */
-    screenToLensMm?: number;
-    /** Radial lens distortion coefficients. Zero disables distortion. */
-    k1: number;
-    k2: number;
-};
-type WebVRChromeAppearance = {
-    background?: CSSProperties["background"];
-    color?: CSSProperties["color"];
-    accent?: CSSProperties["color"];
-    borderRadius?: CSSProperties["borderRadius"];
-    fontSize?: CSSProperties["fontSize"];
-    setupTitle?: ReactNode;
-};
-type WebVRChrome = boolean | WebVRChromeAppearance;
-type WebVRProps = {
-    /** Mount the built-in Enter / Exit / Setup chrome. Defaults to true. */
-    chrome?: WebVRChrome;
-    /** Enable the phone stereoscopic fallback. Defaults to true. */
-    mobileVr?: boolean;
-    /** Treat desktop device-orientation sensors as MobileVR. Defaults to false. */
-    desktopSupport?: boolean;
-    /** Allow a mouse-driven stereoscopic desktop simulation. Defaults to true. */
-    fakeSupport?: boolean;
-    /** Physical diagonal screen size in inches, or automatic detection. */
-    screensize?: number | "auto";
-    /** Headset preset or a custom lens profile. */
-    profile?: WebVRProfileId | WebVRProfile;
-    /** Show a center reticle in VR. Defaults to true. */
-    cursor?: boolean;
-    /**
-     * Milliseconds to keep looking at a hotspot before a gaze click.
-     * Defaults to 1500. Set to 0 to disable auto-click.
-     */
-    cursorDwellMs?: number;
-    /**
-     * Keep the display awake while MobileVR or simulated VR is active.
-     * Uses the Screen Wake Lock API when available, otherwise a looping
-     * hidden video. Defaults to true.
-     */
-    wakelock?: boolean;
-    /**
-     * Lock the mouse in simulated desktop VR so movement looks around with
-     * no visible cursor. Click the view to re-lock after Escape. Defaults to true.
-     */
-    mousePointerLock?: boolean;
-    onAvailable?: () => void;
-    onUnavailable?: () => void;
-    onEnterVR?: (mode: WebVRMode) => void;
-    onExitVR?: (mode: WebVRMode) => void;
-    onDenied?: (error?: unknown) => void;
-    onUnknownDevice?: () => void;
-};
-type WebVRHandle = {
-    enterVR: () => Promise<boolean>;
-    exitVR: () => Promise<void>;
-    toggleVR: () => Promise<boolean>;
-    isAvailable: () => boolean;
-    isEnabled: () => boolean;
-    getMode: () => WebVRMode | null;
-    requestPermission: () => Promise<boolean>;
-};
-type WebVRSettings = {
-    screensize: number | "auto";
-    profileId: WebVRProfileId;
-};
-
 declare const WebVR: react.ForwardRefExoticComponent<WebVRProps & react.RefAttributes<WebVRHandle>>;
 
 declare const DEFAULT_WEBVR_CHROME_APPEARANCE: Required<Omit<WebVRChromeAppearance, "setupTitle">>;
@@ -812,113 +1038,6 @@ type SphereProps = {
 };
 declare function Sphere({ src, previewUrl, yawOffset, onReady, onLoad, onError, onPreviewError, visible, }: SphereProps): react.JSX.Element | null;
 
-type VideoPlaybackState = "playing" | "paused" | "ended" | "blocked";
-type VideoHotspotErrorEvent = {
-    id: string;
-    source: "poster" | "video";
-    error: unknown;
-};
-type VideoHotspotProps = HotspotCommonProps & {
-    src: string;
-    playing: boolean;
-    poster?: string;
-    loop?: boolean;
-    muted?: boolean;
-    volume?: number;
-    playsInline?: boolean;
-    preload?: "none" | "metadata" | "auto";
-    crossOrigin?: "" | "anonymous" | "use-credentials";
-    onPlaybackStateChange?: (state: VideoPlaybackState) => void;
-    onPlaybackError?: (error: unknown) => void;
-    onEnded?: () => void;
-    onError?: (event: VideoHotspotErrorEvent) => void;
-};
-declare function VideoHotspot({ id, src, playing, poster, loop, muted, volume, playsInline, preload, crossOrigin, width, height, opacity, onPlaybackStateChange, onPlaybackError, onEnded, onError, ...anchorProps }: VideoHotspotProps): react.JSX.Element;
-
-type PanoVideoSource = {
-    src: string;
-    type?: string;
-};
-type PanoVideoVariant = {
-    id: string;
-    label: string;
-    poster?: string;
-    sources: readonly PanoVideoSource[];
-};
-type PanoVideoTrackKind = "subtitles" | "captions";
-type PanoVideoTrack = {
-    /** Defaults to `srcLang`. */
-    id?: string;
-    src: string;
-    srcLang: string;
-    label: string;
-    kind?: PanoVideoTrackKind;
-    default?: boolean;
-};
-type PanoVideoCaptionAppearance = {
-    color?: string;
-    background?: string;
-    fontSize?: number | string;
-    fontFamily?: string;
-    fontWeight?: CSSProperties["fontWeight"];
-    textShadow?: string;
-    padding?: string;
-    borderRadius?: number | string;
-    maxWidth?: number | string;
-    bottom?: number | string;
-    lineHeight?: number | string;
-};
-type PanoVideoControlsAppearance = {
-    background?: string;
-    color?: string;
-    accent?: string;
-    borderRadius?: number | string;
-    fontSize?: number | string;
-    padding?: string;
-};
-type PanoVideoErrorSource = "poster" | "video" | "track";
-type PanoVideoErrorEvent = {
-    source: PanoVideoErrorSource;
-    error: unknown;
-};
-type PanoVideoPlaybackSnapshot = {
-    ready: boolean;
-    playing: boolean;
-    blocked: boolean;
-    ended: boolean;
-    currentTime: number;
-    duration: number;
-    volume: number;
-    /** False when the element ignores `volume` (iOS Safari). Mute still works. */
-    volumeAdjustable: boolean;
-    muted: boolean;
-    playbackRate: number;
-    variantId: string;
-    variants: readonly PanoVideoVariant[];
-    trackId: string | null;
-    tracks: readonly PanoVideoTrack[];
-    captionText: string;
-    captionAppearance: Required<PanoVideoCaptionAppearance>;
-    captionsEnabled: boolean;
-    playbackRates: readonly number[];
-    playbackState: VideoPlaybackState;
-};
-type PanoVideoController = {
-    subscribe: (onStoreChange: () => void) => () => void;
-    getSnapshot: () => PanoVideoPlaybackSnapshot;
-    play: () => Promise<void>;
-    pause: () => void;
-    togglePlay: () => void;
-    seek: (time: number) => void;
-    setVolume: (volume: number) => void;
-    setMuted: (muted: boolean) => void;
-    toggleMuted: () => void;
-    setPlaybackRate: (rate: number) => void;
-    setVariantId: (id: string) => void;
-    setTrackId: (id: string | null) => void;
-    setCaptionAppearance: (appearance: Partial<PanoVideoCaptionAppearance>) => void;
-};
-
 type PanoVideoProps = {
     /** Single-file shortcut when `variants` is omitted. */
     src?: string;
@@ -1084,7 +1203,19 @@ type SceneTransitionErrorEvent = {
 };
 type ScenesProps = {
     scenes: readonly Scene[];
-    activeSceneId: string;
+    /**
+     * Controlled scene id. When provided, the parent owns the active scene.
+     * Imperative `setScene` / `nextScene` / `previousScene` will call
+     * `onActiveSceneIdChange` so the parent can update its state.
+     */
+    activeSceneId?: string;
+    /**
+     * Uncontrolled initial scene id. Used when `activeSceneId` is omitted.
+     * Imperative calls update the internal state directly.
+     */
+    defaultActiveSceneId?: string;
+    /** Called when imperative scene methods request a scene change in controlled mode. */
+    onActiveSceneIdChange?: (id: string) => void;
     transition?: SceneTransition;
     /** Rendered only after a scene has finished transitioning in. */
     renderHotspots?: (scene: Scene) => ReactNode;
@@ -1097,7 +1228,16 @@ type ScenesProps = {
     /** Maximum physical-pixel area of the outgoing GPU snapshot. */
     snapshotMaxPixels?: number;
 };
-declare function Scenes({ maxTextureMemoryMb, maxConcurrentTileLoads, ...props }: ScenesProps): react.JSX.Element;
+declare function Scenes({ maxTextureMemoryMb, maxConcurrentTileLoads, activeSceneId: controlledId, defaultActiveSceneId, onActiveSceneIdChange, scenes, ...rest }: ScenesProps): react.JSX.Element;
+
+type ScenesController = {
+    setScene: (id: string) => boolean;
+    nextScene: () => boolean;
+    previousScene: () => boolean;
+    getActiveSceneId: () => string;
+    getSceneIds: () => readonly string[];
+    isTransitioning: () => boolean;
+};
 
 type ImageHotspotProps = HotspotCommonProps & {
     src: string;
@@ -1379,6 +1519,20 @@ type VideoHotspotDefinition = PointHotspotDefinitionBase & {
     preload?: "none" | "metadata" | "auto";
     crossOrigin?: "" | "anonymous" | "use-credentials";
 };
+type AudioHotspotDefinition = PointHotspotDefinitionBase & {
+    type: "audio";
+    src: string | string[];
+    playing?: boolean;
+    loop?: boolean;
+    muted?: boolean;
+    volume?: number;
+    pauseWhenHidden?: boolean;
+    range?: number;
+    icon?: string;
+    playingIcon?: string;
+    marker?: boolean;
+    crossOrigin?: "" | "anonymous" | "use-credentials";
+};
 type TextHotspotDefinition = PointHotspotDefinitionBase & TextHotspotStyle & {
     type: "text";
     text: string;
@@ -1415,8 +1569,8 @@ type PolylineHotspotDefinition = HotspotDefinitionBase & {
     strokeDashSize?: number;
     strokeGapSize?: number;
 };
-type PointHotspotDefinition = ImageHotspotDefinition | GraphicHotspotDefinition | SequenceHotspotDefinition | VideoHotspotDefinition | TextHotspotDefinition | IframeHotspotDefinition;
+type PointHotspotDefinition = ImageHotspotDefinition | GraphicHotspotDefinition | SequenceHotspotDefinition | VideoHotspotDefinition | AudioHotspotDefinition | TextHotspotDefinition | IframeHotspotDefinition;
 /** A serializable, discriminated hotspot collection item. */
 type HotspotDefinition = PointHotspotDefinition | PolygonHotspotDefinition | PolylineHotspotDefinition;
 
-export { type ArrowGraphic, AutoRotate, type AutoRotateProps, type CircleGraphic, type CubeFaceCode, DEFAULT_HOTSPOT_TOOLTIP_APPEARANCE, DEFAULT_HOTSPOT_TOOLTIP_OFFSET, DEFAULT_PANO_CURSORS, DEFAULT_PANO_VIDEO_CAPTION_APPEARANCE, DEFAULT_PANO_VIDEO_CONTROLS_APPEARANCE, DEFAULT_PANO_VIDEO_PLAYBACK_RATES, DEFAULT_WEBVR_CHROME_APPEARANCE, DEFAULT_WEBVR_CURSOR_DWELL_MS, type DiamondGraphic, type GraphicDefinition, GraphicHotspot, type GraphicHotspotDefinition, type GraphicHotspotProps, Gyro, type GyroHandle, type GyroProps, type GyroTouchMode, type HotspotCommonProps, type HotspotDefinition, type HotspotDefinitionBase, type HotspotDragEvent, type HotspotInputSource, type HotspotInteractionEvent, type HotspotMode, type HotspotPointerEvents, type HotspotPosition, type HotspotScaleMode, type HotspotTooltipAppearance, type HotspotTooltipContent, type HotspotTooltipPlacement, type HotspotTooltipTrigger, IframeHotspot, type IframeHotspotDefinition, type IframeHotspotProps, type IframePointerPolicy, ImageHotspot, type ImageHotspotDefinition, type ImageHotspotProps, type KeyboardControlAction, type KeyboardControlKeys, KeyboardControls, type KeyboardControlsProps, MAX_HOTSPOT_PITCH, MIN_PANO_CONTEXT_MENU_BACKGROUND_OPACITY, type MouseControlButton, MouseControls, type MouseControlsOptions, type MouseControlsProps, PANO_FILTER_PRESETS, PanoContextMenu, type PanoContextMenuActionItem, type PanoContextMenuAppearance, type PanoContextMenuEntry, type PanoContextMenuItem, type PanoContextMenuPresetActions, type PanoContextMenuPresetId, type PanoContextMenuPresetRef, type PanoContextMenuPresets, type PanoContextMenuProps, type PanoContextMenuRenderProps, type PanoContextMenuSelectContext, type PanoContextMenuSeparatorItem, type PanoCursor, type PanoCursors, type PanoEventBus, type PanoEventListener, type PanoEventMap, type PanoEventType, PanoEvents, type PanoEventsProps, PanoFilter, type PanoFilterPreset, type PanoFilterProps, type PanoResizeEvent, PanoVideo, type PanoVideoCaptionAppearance, type PanoVideoController, PanoVideoControls, type PanoVideoControlsAppearance, type PanoVideoControlsProps, type PanoVideoErrorEvent, type PanoVideoErrorSource, type PanoVideoPlaybackSnapshot, type PanoVideoProps, type PanoVideoSource, type PanoVideoTrack, type PanoVideoTrackKind, type PanoVideoVariant, PanoViewer, type PanoViewerHandle, type PanoViewerProps, type PanoViewerState, type PanoWheelEvent, type PanoramaControlsOptions, type PanoramaPointerEvent, type PointHotspotDefinition, type PointHotspotDefinitionBase, PolygonHotspot, type PolygonHotspotDefinition, type PolygonHotspotProps, type PolygonValidationCode, type PolygonValidationIssue, type PolygonVerticesChangeEvent, PolylineHotspot, type PolylineHotspotDefinition, type PolylineHotspotProps, type PolylineValidationIssue, type PolylineVerticesChangeEvent, type RectangleGraphic, type RingGraphic, type Scene, type SceneTransition, type SceneTransitionEndEvent, type SceneTransitionErrorEvent, type SceneTransitionPreset, Scenes, type ScenesProps, type SequenceFrameDirection, type SequenceFrameEvent, SequenceHotspot, type SequenceHotspotDefinition, type SequenceHotspotErrorEvent, type SequenceHotspotProps, type SequenceLoadProgress, type SequencePlaybackState, type SetPanoViewerOptions, Sphere, type SphereProps, type SphereScene, type StarGraphic, type SvgGraphic, type SvgPathGraphic, TextHotspot, type TextHotspotAlign, type TextHotspotDefinition, type TextHotspotFontStyle, type TextHotspotProps, type TextHotspotStyle, type TextHotspotVerticalAlign, type TextHotspotWhiteSpace, Tile, type TileAddress, type TileLoadError, type TileLoadProgress, type TileMultiresConfig, type TileProps, type TileScene, TouchControls, type TouchControlsOptions, type TouchControlsProps, type TriangleGraphic, VideoHotspot, type VideoHotspotDefinition, type VideoHotspotErrorEvent, type VideoHotspotProps, type VideoPlaybackState, type ViewInteractionEvent, type ViewInteractionSource, WEBVR_PROFILES, WEBVR_PROFILE_IDS, WebVR, type WebVRChrome, type WebVRChromeAppearance, type WebVRHandle, type WebVRMode, type WebVRProfile, type WebVRProfileId, type WebVRProps, type WebVRSettings, clampPanoPitch, composePanoContextMenuItems, createDefaultPanoContextMenuItems, createPanoContextMenuPresets, cycleSceneId, normalizePanoPosition, normalizePanoYaw, panoPositionToVector3, resolvePanoContextMenuEntries, unwrapPolygonVertices, usePanoEvents, validatePolygonVertices, validatePolylineVertices, vector3ToPanoPosition };
+export { type ArrowGraphic, AudioHotspot, type AudioHotspotDefinition, type AudioHotspotErrorEvent, type AudioHotspotProps, type AudioPlaybackState, AutoRotate, type AutoRotateProps, BackgroundAudio, type BackgroundAudioController, type BackgroundAudioErrorEvent, type BackgroundAudioProps, type BackgroundAudioSnapshot, type BackgroundAudioSource, type CircleGraphic, type CubeFaceCode, DEFAULT_HOTSPOT_TOOLTIP_APPEARANCE, DEFAULT_HOTSPOT_TOOLTIP_OFFSET, DEFAULT_PANO_CURSORS, DEFAULT_PANO_VIDEO_CAPTION_APPEARANCE, DEFAULT_PANO_VIDEO_CONTROLS_APPEARANCE, DEFAULT_PANO_VIDEO_PLAYBACK_RATES, DEFAULT_WEBVR_CHROME_APPEARANCE, DEFAULT_WEBVR_CURSOR_DWELL_MS, type DiamondGraphic, type GraphicDefinition, GraphicHotspot, type GraphicHotspotDefinition, type GraphicHotspotProps, Gyro, type GyroHandle, type GyroProps, type GyroTouchMode, type HotspotCommonProps, type HotspotDefinition, type HotspotDefinitionBase, type HotspotDragEvent, type HotspotInputSource, type HotspotInteractionEvent, type HotspotMode, type HotspotPointerEvents, type HotspotPosition, type HotspotScaleMode, type HotspotTooltipAppearance, type HotspotTooltipContent, type HotspotTooltipPlacement, type HotspotTooltipTrigger, IframeHotspot, type IframeHotspotDefinition, type IframeHotspotProps, type IframePointerPolicy, ImageHotspot, type ImageHotspotDefinition, type ImageHotspotProps, type KeyboardControlAction, type KeyboardControlKeys, KeyboardControls, type KeyboardControlsProps, MAX_HOTSPOT_PITCH, MIN_PANO_CONTEXT_MENU_BACKGROUND_OPACITY, type MouseControlButton, MouseControls, type MouseControlsOptions, type MouseControlsProps, PANO_FILTER_PRESETS, PanoContextMenu, type PanoContextMenuActionItem, type PanoContextMenuAppearance, type PanoContextMenuEntry, type PanoContextMenuItem, type PanoContextMenuPresetActions, type PanoContextMenuPresetId, type PanoContextMenuPresetRef, type PanoContextMenuPresets, type PanoContextMenuProps, type PanoContextMenuRenderProps, type PanoContextMenuSelectContext, type PanoContextMenuSeparatorItem, type PanoCursor, type PanoCursors, type PanoEventBus, type PanoEventListener, type PanoEventMap, type PanoEventType, PanoEvents, type PanoEventsProps, PanoFilter, type PanoFilterPreset, type PanoFilterProps, type PanoResizeEvent, PanoVideo, type PanoVideoCaptionAppearance, type PanoVideoController, PanoVideoControls, type PanoVideoControlsAppearance, type PanoVideoControlsProps, type PanoVideoErrorEvent, type PanoVideoErrorSource, type PanoVideoPlaybackSnapshot, type PanoVideoProps, type PanoVideoSource, type PanoVideoTrack, type PanoVideoTrackKind, type PanoVideoVariant, PanoViewer, type PanoViewerHandle, type PanoViewerProps, type PanoViewerState, type PanoWheelEvent, type PanoramaControlsOptions, type PanoramaPointerEvent, type PointHotspotDefinition, type PointHotspotDefinitionBase, PolygonHotspot, type PolygonHotspotDefinition, type PolygonHotspotProps, type PolygonValidationCode, type PolygonValidationIssue, type PolygonVerticesChangeEvent, PolylineHotspot, type PolylineHotspotDefinition, type PolylineHotspotProps, type PolylineValidationIssue, type PolylineVerticesChangeEvent, type RectangleGraphic, type RingGraphic, type Scene, type SceneTransition, type SceneTransitionEndEvent, type SceneTransitionErrorEvent, type SceneTransitionPreset, Scenes, type ScenesController, type ScenesProps, type SequenceFrameDirection, type SequenceFrameEvent, SequenceHotspot, type SequenceHotspotDefinition, type SequenceHotspotErrorEvent, type SequenceHotspotProps, type SequenceLoadProgress, type SequencePlaybackState, type SetPanoViewerOptions, Sphere, type SphereProps, type SphereScene, type StarGraphic, type SvgGraphic, type SvgPathGraphic, TextHotspot, type TextHotspotAlign, type TextHotspotDefinition, type TextHotspotFontStyle, type TextHotspotProps, type TextHotspotStyle, type TextHotspotVerticalAlign, type TextHotspotWhiteSpace, Tile, type TileAddress, type TileLoadError, type TileLoadProgress, type TileMultiresConfig, type TileProps, type TileScene, TouchControls, type TouchControlsOptions, type TouchControlsProps, type TriangleGraphic, VideoHotspot, type VideoHotspotDefinition, type VideoHotspotErrorEvent, type VideoHotspotProps, type VideoPlaybackState, type ViewInteractionEvent, type ViewInteractionSource, WEBVR_PROFILES, WEBVR_PROFILE_IDS, WebVR, type WebVRChrome, type WebVRChromeAppearance, type WebVRHandle, type WebVRMode, type WebVRProfile, type WebVRProfileId, type WebVRProps, type WebVRSettings, clampPanoPitch, composePanoContextMenuItems, createDefaultPanoContextMenuItems, createPanoContextMenuPresets, cycleSceneId, normalizePanoPosition, normalizePanoYaw, panoPositionToVector3, resolvePanoContextMenuEntries, unwrapPolygonVertices, usePanoEvents, validatePolygonVertices, validatePolylineVertices, vector3ToPanoPosition };