@ericchen1990/pano-view 2.2.1 → 2.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +126 -7
- package/README.zh-CN.md +87 -3
- package/dist/index.cjs +3489 -560
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.mts +80 -4
- package/dist/index.d.ts +80 -4
- package/dist/index.mjs +3280 -334
- package/dist/index.mjs.map +1 -1
- package/package.json +4 -2
package/dist/index.d.mts
CHANGED
|
@@ -460,7 +460,8 @@ type PanoViewerProps = Omit<ComponentPropsWithoutRef<"div">, "children" | "onCha
|
|
|
460
460
|
* Default context menu. `true` / omit mounts Reset view + Fullscreen;
|
|
461
461
|
* `false` skips the default instance; an object merges appearance and
|
|
462
462
|
* may use `items` (full replace, supports preset ids), or `prepend` /
|
|
463
|
-
* `append` to keep the defaults and add entries.
|
|
463
|
+
* `append` to keep the defaults and add entries. The browser's native
|
|
464
|
+
* context menu is always suppressed on the viewer, including overlays.
|
|
464
465
|
*/
|
|
465
466
|
contextMenu?: boolean | PanoContextMenuProps;
|
|
466
467
|
onViewChange?: (view: PanoViewerState) => void;
|
|
@@ -486,7 +487,8 @@ declare const PanoViewer: react.ForwardRefExoticComponent<Omit<Omit<react.Detail
|
|
|
486
487
|
* Default context menu. `true` / omit mounts Reset view + Fullscreen;
|
|
487
488
|
* `false` skips the default instance; an object merges appearance and
|
|
488
489
|
* may use `items` (full replace, supports preset ids), or `prepend` /
|
|
489
|
-
* `append` to keep the defaults and add entries.
|
|
490
|
+
* `append` to keep the defaults and add entries. The browser's native
|
|
491
|
+
* context menu is always suppressed on the viewer, including overlays.
|
|
490
492
|
*/
|
|
491
493
|
contextMenu?: boolean | PanoContextMenuProps;
|
|
492
494
|
onViewChange?: (view: PanoViewerState) => void;
|
|
@@ -517,6 +519,66 @@ type AutoRotateProps = {
|
|
|
517
519
|
*/
|
|
518
520
|
declare function AutoRotate({ enabled, speed, acceleration, startDelay, }: AutoRotateProps): null;
|
|
519
521
|
|
|
522
|
+
type AudioPlaybackState = "playing" | "paused" | "ended" | "blocked";
|
|
523
|
+
type AudioHotspotErrorEvent = {
|
|
524
|
+
id: string;
|
|
525
|
+
error: unknown;
|
|
526
|
+
};
|
|
527
|
+
type AudioHotspotProps = HotspotCommonProps & {
|
|
528
|
+
src: string | string[];
|
|
529
|
+
playing: boolean;
|
|
530
|
+
loop?: boolean;
|
|
531
|
+
muted?: boolean;
|
|
532
|
+
volume?: number;
|
|
533
|
+
/** Degrees of look-away before the source is silent. Defaults to 360 (no look attenuation). */
|
|
534
|
+
range?: number;
|
|
535
|
+
pauseWhenHidden?: boolean;
|
|
536
|
+
/** Optional stopped-state image. When omitted, a built-in speaker icon is used. */
|
|
537
|
+
icon?: string;
|
|
538
|
+
/** Optional playing-state image. Falls back to `icon`, then the built-in playing icon. */
|
|
539
|
+
playingIcon?: string;
|
|
540
|
+
/** When false, no visual marker is rendered. Audio still plays. Defaults to true. */
|
|
541
|
+
marker?: boolean;
|
|
542
|
+
crossOrigin?: "" | "anonymous" | "use-credentials";
|
|
543
|
+
onPlaybackStateChange?: (state: AudioPlaybackState) => void;
|
|
544
|
+
onPlaybackError?: (error: unknown) => void;
|
|
545
|
+
onEnded?: () => void;
|
|
546
|
+
onError?: (event: AudioHotspotErrorEvent) => void;
|
|
547
|
+
};
|
|
548
|
+
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;
|
|
549
|
+
|
|
550
|
+
type BackgroundAudioSource = string | readonly string[];
|
|
551
|
+
type BackgroundAudioErrorEvent = {
|
|
552
|
+
error: unknown;
|
|
553
|
+
};
|
|
554
|
+
type BackgroundAudioProps = {
|
|
555
|
+
/** Shared tour track when `sources` is omitted, or fallback when a scene has no entry. */
|
|
556
|
+
src?: BackgroundAudioSource;
|
|
557
|
+
/** Per-scene tracks keyed by `Scene.id`. Requires `sceneId`. */
|
|
558
|
+
sources?: Readonly<Record<string, BackgroundAudioSource>>;
|
|
559
|
+
/** Current scene id. Required when `sources` is set. */
|
|
560
|
+
sceneId?: string;
|
|
561
|
+
playing: boolean;
|
|
562
|
+
/** Defaults to true. */
|
|
563
|
+
loop?: boolean;
|
|
564
|
+
muted?: boolean;
|
|
565
|
+
volume?: number;
|
|
566
|
+
pauseWhenHidden?: boolean;
|
|
567
|
+
/** Crossfade duration when the resolved track changes. Defaults to 400; 0 is a hard cut. */
|
|
568
|
+
fadeMs?: number;
|
|
569
|
+
crossOrigin?: "" | "anonymous" | "use-credentials";
|
|
570
|
+
onPlaybackStateChange?: (state: AudioPlaybackState) => void;
|
|
571
|
+
onPlaybackError?: (error: unknown) => void;
|
|
572
|
+
onEnded?: () => void;
|
|
573
|
+
onError?: (event: BackgroundAudioErrorEvent) => void;
|
|
574
|
+
};
|
|
575
|
+
/**
|
|
576
|
+
* Adds a non-spatial soundtrack to the nearest PanoViewer. Render one instance
|
|
577
|
+
* as a child of PanoViewer, alongside Scenes or a panorama source — not inside
|
|
578
|
+
* renderHotspots.
|
|
579
|
+
*/
|
|
580
|
+
declare function BackgroundAudio({ src, sources, sceneId, playing, loop, muted, volume, pauseWhenHidden, fadeMs, crossOrigin, onPlaybackStateChange, onPlaybackError, onEnded, onError, }: BackgroundAudioProps): null;
|
|
581
|
+
|
|
520
582
|
declare const PANO_FILTER_PRESETS: readonly ["none", "grayscale", "sepia", "vintage", "cool", "warm", "pencil", "coloredPencil", "crayon", "watercolor", "cartoon", "crosshatch"];
|
|
521
583
|
type PanoFilterPreset = (typeof PANO_FILTER_PRESETS)[number];
|
|
522
584
|
|
|
@@ -1377,6 +1439,20 @@ type VideoHotspotDefinition = PointHotspotDefinitionBase & {
|
|
|
1377
1439
|
preload?: "none" | "metadata" | "auto";
|
|
1378
1440
|
crossOrigin?: "" | "anonymous" | "use-credentials";
|
|
1379
1441
|
};
|
|
1442
|
+
type AudioHotspotDefinition = PointHotspotDefinitionBase & {
|
|
1443
|
+
type: "audio";
|
|
1444
|
+
src: string | string[];
|
|
1445
|
+
playing?: boolean;
|
|
1446
|
+
loop?: boolean;
|
|
1447
|
+
muted?: boolean;
|
|
1448
|
+
volume?: number;
|
|
1449
|
+
pauseWhenHidden?: boolean;
|
|
1450
|
+
range?: number;
|
|
1451
|
+
icon?: string;
|
|
1452
|
+
playingIcon?: string;
|
|
1453
|
+
marker?: boolean;
|
|
1454
|
+
crossOrigin?: "" | "anonymous" | "use-credentials";
|
|
1455
|
+
};
|
|
1380
1456
|
type TextHotspotDefinition = PointHotspotDefinitionBase & TextHotspotStyle & {
|
|
1381
1457
|
type: "text";
|
|
1382
1458
|
text: string;
|
|
@@ -1413,8 +1489,8 @@ type PolylineHotspotDefinition = HotspotDefinitionBase & {
|
|
|
1413
1489
|
strokeDashSize?: number;
|
|
1414
1490
|
strokeGapSize?: number;
|
|
1415
1491
|
};
|
|
1416
|
-
type PointHotspotDefinition = ImageHotspotDefinition | GraphicHotspotDefinition | SequenceHotspotDefinition | VideoHotspotDefinition | TextHotspotDefinition | IframeHotspotDefinition;
|
|
1492
|
+
type PointHotspotDefinition = ImageHotspotDefinition | GraphicHotspotDefinition | SequenceHotspotDefinition | VideoHotspotDefinition | AudioHotspotDefinition | TextHotspotDefinition | IframeHotspotDefinition;
|
|
1417
1493
|
/** A serializable, discriminated hotspot collection item. */
|
|
1418
1494
|
type HotspotDefinition = PointHotspotDefinition | PolygonHotspotDefinition | PolylineHotspotDefinition;
|
|
1419
1495
|
|
|
1420
|
-
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 };
|
|
1496
|
+
export { type ArrowGraphic, AudioHotspot, type AudioHotspotDefinition, type AudioHotspotErrorEvent, type AudioHotspotProps, type AudioPlaybackState, AutoRotate, type AutoRotateProps, BackgroundAudio, type BackgroundAudioErrorEvent, type BackgroundAudioProps, 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 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 };
|
package/dist/index.d.ts
CHANGED
|
@@ -460,7 +460,8 @@ type PanoViewerProps = Omit<ComponentPropsWithoutRef<"div">, "children" | "onCha
|
|
|
460
460
|
* Default context menu. `true` / omit mounts Reset view + Fullscreen;
|
|
461
461
|
* `false` skips the default instance; an object merges appearance and
|
|
462
462
|
* may use `items` (full replace, supports preset ids), or `prepend` /
|
|
463
|
-
* `append` to keep the defaults and add entries.
|
|
463
|
+
* `append` to keep the defaults and add entries. The browser's native
|
|
464
|
+
* context menu is always suppressed on the viewer, including overlays.
|
|
464
465
|
*/
|
|
465
466
|
contextMenu?: boolean | PanoContextMenuProps;
|
|
466
467
|
onViewChange?: (view: PanoViewerState) => void;
|
|
@@ -486,7 +487,8 @@ declare const PanoViewer: react.ForwardRefExoticComponent<Omit<Omit<react.Detail
|
|
|
486
487
|
* Default context menu. `true` / omit mounts Reset view + Fullscreen;
|
|
487
488
|
* `false` skips the default instance; an object merges appearance and
|
|
488
489
|
* may use `items` (full replace, supports preset ids), or `prepend` /
|
|
489
|
-
* `append` to keep the defaults and add entries.
|
|
490
|
+
* `append` to keep the defaults and add entries. The browser's native
|
|
491
|
+
* context menu is always suppressed on the viewer, including overlays.
|
|
490
492
|
*/
|
|
491
493
|
contextMenu?: boolean | PanoContextMenuProps;
|
|
492
494
|
onViewChange?: (view: PanoViewerState) => void;
|
|
@@ -517,6 +519,66 @@ type AutoRotateProps = {
|
|
|
517
519
|
*/
|
|
518
520
|
declare function AutoRotate({ enabled, speed, acceleration, startDelay, }: AutoRotateProps): null;
|
|
519
521
|
|
|
522
|
+
type AudioPlaybackState = "playing" | "paused" | "ended" | "blocked";
|
|
523
|
+
type AudioHotspotErrorEvent = {
|
|
524
|
+
id: string;
|
|
525
|
+
error: unknown;
|
|
526
|
+
};
|
|
527
|
+
type AudioHotspotProps = HotspotCommonProps & {
|
|
528
|
+
src: string | string[];
|
|
529
|
+
playing: boolean;
|
|
530
|
+
loop?: boolean;
|
|
531
|
+
muted?: boolean;
|
|
532
|
+
volume?: number;
|
|
533
|
+
/** Degrees of look-away before the source is silent. Defaults to 360 (no look attenuation). */
|
|
534
|
+
range?: number;
|
|
535
|
+
pauseWhenHidden?: boolean;
|
|
536
|
+
/** Optional stopped-state image. When omitted, a built-in speaker icon is used. */
|
|
537
|
+
icon?: string;
|
|
538
|
+
/** Optional playing-state image. Falls back to `icon`, then the built-in playing icon. */
|
|
539
|
+
playingIcon?: string;
|
|
540
|
+
/** When false, no visual marker is rendered. Audio still plays. Defaults to true. */
|
|
541
|
+
marker?: boolean;
|
|
542
|
+
crossOrigin?: "" | "anonymous" | "use-credentials";
|
|
543
|
+
onPlaybackStateChange?: (state: AudioPlaybackState) => void;
|
|
544
|
+
onPlaybackError?: (error: unknown) => void;
|
|
545
|
+
onEnded?: () => void;
|
|
546
|
+
onError?: (event: AudioHotspotErrorEvent) => void;
|
|
547
|
+
};
|
|
548
|
+
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;
|
|
549
|
+
|
|
550
|
+
type BackgroundAudioSource = string | readonly string[];
|
|
551
|
+
type BackgroundAudioErrorEvent = {
|
|
552
|
+
error: unknown;
|
|
553
|
+
};
|
|
554
|
+
type BackgroundAudioProps = {
|
|
555
|
+
/** Shared tour track when `sources` is omitted, or fallback when a scene has no entry. */
|
|
556
|
+
src?: BackgroundAudioSource;
|
|
557
|
+
/** Per-scene tracks keyed by `Scene.id`. Requires `sceneId`. */
|
|
558
|
+
sources?: Readonly<Record<string, BackgroundAudioSource>>;
|
|
559
|
+
/** Current scene id. Required when `sources` is set. */
|
|
560
|
+
sceneId?: string;
|
|
561
|
+
playing: boolean;
|
|
562
|
+
/** Defaults to true. */
|
|
563
|
+
loop?: boolean;
|
|
564
|
+
muted?: boolean;
|
|
565
|
+
volume?: number;
|
|
566
|
+
pauseWhenHidden?: boolean;
|
|
567
|
+
/** Crossfade duration when the resolved track changes. Defaults to 400; 0 is a hard cut. */
|
|
568
|
+
fadeMs?: number;
|
|
569
|
+
crossOrigin?: "" | "anonymous" | "use-credentials";
|
|
570
|
+
onPlaybackStateChange?: (state: AudioPlaybackState) => void;
|
|
571
|
+
onPlaybackError?: (error: unknown) => void;
|
|
572
|
+
onEnded?: () => void;
|
|
573
|
+
onError?: (event: BackgroundAudioErrorEvent) => void;
|
|
574
|
+
};
|
|
575
|
+
/**
|
|
576
|
+
* Adds a non-spatial soundtrack to the nearest PanoViewer. Render one instance
|
|
577
|
+
* as a child of PanoViewer, alongside Scenes or a panorama source — not inside
|
|
578
|
+
* renderHotspots.
|
|
579
|
+
*/
|
|
580
|
+
declare function BackgroundAudio({ src, sources, sceneId, playing, loop, muted, volume, pauseWhenHidden, fadeMs, crossOrigin, onPlaybackStateChange, onPlaybackError, onEnded, onError, }: BackgroundAudioProps): null;
|
|
581
|
+
|
|
520
582
|
declare const PANO_FILTER_PRESETS: readonly ["none", "grayscale", "sepia", "vintage", "cool", "warm", "pencil", "coloredPencil", "crayon", "watercolor", "cartoon", "crosshatch"];
|
|
521
583
|
type PanoFilterPreset = (typeof PANO_FILTER_PRESETS)[number];
|
|
522
584
|
|
|
@@ -1377,6 +1439,20 @@ type VideoHotspotDefinition = PointHotspotDefinitionBase & {
|
|
|
1377
1439
|
preload?: "none" | "metadata" | "auto";
|
|
1378
1440
|
crossOrigin?: "" | "anonymous" | "use-credentials";
|
|
1379
1441
|
};
|
|
1442
|
+
type AudioHotspotDefinition = PointHotspotDefinitionBase & {
|
|
1443
|
+
type: "audio";
|
|
1444
|
+
src: string | string[];
|
|
1445
|
+
playing?: boolean;
|
|
1446
|
+
loop?: boolean;
|
|
1447
|
+
muted?: boolean;
|
|
1448
|
+
volume?: number;
|
|
1449
|
+
pauseWhenHidden?: boolean;
|
|
1450
|
+
range?: number;
|
|
1451
|
+
icon?: string;
|
|
1452
|
+
playingIcon?: string;
|
|
1453
|
+
marker?: boolean;
|
|
1454
|
+
crossOrigin?: "" | "anonymous" | "use-credentials";
|
|
1455
|
+
};
|
|
1380
1456
|
type TextHotspotDefinition = PointHotspotDefinitionBase & TextHotspotStyle & {
|
|
1381
1457
|
type: "text";
|
|
1382
1458
|
text: string;
|
|
@@ -1413,8 +1489,8 @@ type PolylineHotspotDefinition = HotspotDefinitionBase & {
|
|
|
1413
1489
|
strokeDashSize?: number;
|
|
1414
1490
|
strokeGapSize?: number;
|
|
1415
1491
|
};
|
|
1416
|
-
type PointHotspotDefinition = ImageHotspotDefinition | GraphicHotspotDefinition | SequenceHotspotDefinition | VideoHotspotDefinition | TextHotspotDefinition | IframeHotspotDefinition;
|
|
1492
|
+
type PointHotspotDefinition = ImageHotspotDefinition | GraphicHotspotDefinition | SequenceHotspotDefinition | VideoHotspotDefinition | AudioHotspotDefinition | TextHotspotDefinition | IframeHotspotDefinition;
|
|
1417
1493
|
/** A serializable, discriminated hotspot collection item. */
|
|
1418
1494
|
type HotspotDefinition = PointHotspotDefinition | PolygonHotspotDefinition | PolylineHotspotDefinition;
|
|
1419
1495
|
|
|
1420
|
-
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 };
|
|
1496
|
+
export { type ArrowGraphic, AudioHotspot, type AudioHotspotDefinition, type AudioHotspotErrorEvent, type AudioHotspotProps, type AudioPlaybackState, AutoRotate, type AutoRotateProps, BackgroundAudio, type BackgroundAudioErrorEvent, type BackgroundAudioProps, 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 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 };
|