three-vr-player 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,32 @@
+export type Projection = '180-sbs' | '180-mono' | '360-mono' | '360-sbs' | '360-tb' | 'flat-2d' | 'flat-sbs-full' | 'flat-sbs-half';
+export interface PlayerOptions {
+    /** Initial source URL. If omitted, call `player.load(src)` later. */
+    src?: string;
+    /** Projection mode. Default `'180-sbs'` (or auto-detected from `src`). */
+    projection?: Projection;
+    /** Guess the projection from the src filename on load. Default `true`. */
+    autoDetect?: boolean;
+    /** Render the built-in controls UI. Default `true`. */
+    controls?: boolean;
+    /** Optional CORS proxy (e.g. a mediaflow-proxy) for cross-origin sources. */
+    proxy?: {
+        url: string;
+        apiPassword?: string;
+        headers?: Record<string, string>;
+    };
+    /** Swap which eye's half is shown (for reversed sources). Default `false`. */
+    swapEyes?: boolean;
+    /** Vertical field of view in degrees. Default `70`. */
+    fov?: number;
+    /** Supersampling factor (× devicePixelRatio, capped at 4). Default `1.5`. */
+    supersampling?: number;
+    /** `crossOrigin` for the `<video>`. Default `'anonymous'`; `null` to omit. */
+    crossOrigin?: 'anonymous' | 'use-credentials' | null;
+    /** Persist view settings to localStorage. Default `false`. */
+    persistSettings?: boolean;
+    /** Mount into a Shadow DOM for style isolation. Default `true`. */
+    shadowDom?: boolean;
+    /** Show the Enter-VR button when a headset is available. Default `true`. */
+    vrButton?: boolean;
+}
+export type PlayerEvent = 'ready' | 'play' | 'pause' | 'ended' | 'error' | 'timeupdate' | 'projectionchange' | 'enterxr' | 'exitxr';

package/dist/ui/ControlsUI.d.ts

@@ -0,0 +1,27 @@
+import { Projection } from '../types.js';
+
+/** What the ControlsUI needs from the Player to drive playback + view. */
+export interface PlayerBridge {
+    video: HTMLVideoElement;
+    surface: HTMLElement;
+    fullscreenTarget: HTMLElement;
+    vrButton: HTMLElement;
+    vrSupported(): Promise<boolean>;
+    getProjection(): Projection;
+    setProjection(p: Projection): void;
+    setSwapEyes(v: boolean): void;
+    setFov(deg: number): void;
+    setSupersampling(x: number): void;
+    initial: {
+        swapEyes: boolean;
+        fov: number;
+        supersampling: number;
+    };
+}
+/** Builds the controls bar + settings/menus inside `root` and wires them to `bridge`. */
+export declare class ControlsUI {
+    private readonly nodes;
+    private readonly disposers;
+    constructor(root: ParentNode, bridge: PlayerBridge);
+    dispose(): void;
+}

package/dist/ui/format.d.ts

@@ -0,0 +1,2 @@
+/** Format seconds as m:ss or h:mm:ss. */
+export declare function formatTime(seconds: number): string;

package/dist/webcomponent.d.ts

@@ -0,0 +1,17 @@
+import { Player } from './Player.js';
+
+/**
+ * `<three-video src="…" projection="180-sbs" controls>` — a framework-agnostic
+ * custom element wrapping {@link Player}. Give it a size via CSS.
+ */
+export declare class ThreeVideoElement extends HTMLElement {
+    private player?;
+    static get observedAttributes(): string[];
+    connectedCallback(): void;
+    attributeChangedCallback(name: string, _old: string | null, value: string | null): void;
+    disconnectedCallback(): void;
+    private numAttr;
+    /** The underlying Player instance (for programmatic control). */
+    get api(): Player | undefined;
+}
+export declare function registerWebComponent(tag?: string): void;

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "three-vr-player",
+  "version": "0.1.0",
+  "description": "Embeddable web player for 180/360 and side-by-side/top-bottom 3D video, undistorted on desktop and in WebXR. Built on three.js.",
+  "type": "module",
+  "license": "MIT",
+  "author": "dartagnan309",
+  "repository": { "type": "git", "url": "https://github.com/dartagnan309/three-vr-player" },
+  "keywords": ["webxr", "vr", "180", "360", "sbs", "stereo", "video", "three", "player", "equirectangular"],
+  "sideEffects": ["**/*.css", "./dist/three-vr-player.js", "./dist/three-vr-player.standalone.js"],
+  "files": ["dist"],
+  "main": "./dist/three-vr-player.js",
+  "module": "./dist/three-vr-player.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": { "types": "./dist/index.d.ts", "import": "./dist/three-vr-player.js" },
+    "./core": { "types": "./dist/core/index.d.ts", "import": "./dist/core.js" },
+    "./standalone": "./dist/three-vr-player.standalone.js"
+  },
+  "scripts": {
+    "dev": "vite --config vite.demo.config.ts",
+    "build": "vite build && vite build --config vite.standalone.config.ts",
+    "build:demo": "vite build --config vite.demo.config.ts",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run"
+  },
+  "peerDependencies": { "three": ">=0.160.0 <1" },
+  "optionalDependencies": { "hls.js": "^1.5.0" },
+  "devDependencies": {
+    "three": "^0.160.0",
+    "hls.js": "^1.5.13",
+    "@types/three": "^0.160.0",
+    "typescript": "^5.4.0",
+    "vite": "^5.2.0",
+    "vite-plugin-dts": "^3.9.0",
+    "vitest": "^1.5.0",
+    "jsdom": "^24.0.0"
+  }
+}