videojs-rewind 0.1.0

package/README.md

@@ -0,0 +1,87 @@
+# videojs-rewind
+
+A Live DVR Rewind Plugin for video.js — full-stream seek bar, rewind-to-VOD, quality enforcement, and storyboard thumbnails for live HLS playback.
+
+## Features
+
+- **Custom Seek Bar** — Full-width seek bar that replaces the native `ProgressControl`. Shows stream position relative to the full stream duration (not just the DVR window).
+- **Live/VOD Timer** — Displays "Live" when at the live edge, or `currentTime / totalTime` (e.g., `1:23:45 / 5:15:00`) when seeking through VOD content.
+- **Rewind-to-VOD** — When the user seeks behind the DVR window, automatically fetches a VOD HLS URL and swaps the source. Provides a "Go Live" button to return to the live stream.
+- **Quality Enforcement** — Locks the player to a user-preferred quality level (e.g., 1080p) across source swaps, with an ABR suppression window to avoid thrashing during initial ramp-up.
+- **Storyboard / Seek Thumbnails** — On seek hover, displays a sprite-sheet-based thumbnail preview above the seek bar.
+
+## Installation
+
+```bash
+npm install @ashleyjackson/videojs-rewind
+```
+
+## Usage
+
+```javascript
+import videojs from 'video.js';
+import '@videojs/http-streaming';
+import 'videojs-contrib-quality-levels';
+import '@ashleyjackson/videojs-rewind';
+
+const player = videojs('my-player', {
+  controls: true,
+  autoplay: true,
+  liveui: true,
+  html5: {
+    hls: {
+      overrideNative: true,
+      enableLowInitialPlaylist: true
+    }
+  },
+  plugins: {
+    rewind: {
+      preferredQuality: 1080,
+      enableRewindToVod: true,
+      resolveVodUrl: async (channel, seekTime) => {
+        const vodId = await fetchVodForChannel(channel, seekTime);
+        const hlsUrl = await getSignedVodUrl(vodId);
+        return { vodId, hlsUrl };
+      },
+      storyboard: {
+        fetchInfo: async (vodId, cdnBaseUrl) => {
+          const res = await fetch(`${cdnBaseUrl}/../storyboards/${vodId}-info.json`);
+          return res.json();
+        }
+      }
+    }
+  }
+});
+```
+
+## Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `customSeekBar` | `boolean` | `true` | Enable custom seek bar (replaces native ProgressControl) |
+| `showTotalTime` | `boolean` | `true` | Show total stream time in timer display |
+| `enableRewindToVod` | `boolean` | `true` | Enable rewind-to-VOD flow |
+| `resolveVodUrl` | `function` | `null` | Callback to resolve a VOD URL when seeking behind DVR window |
+| `preferredQuality` | `number \| "auto"` | `"auto"` | Preferred quality height (e.g., `1080`) or `"auto"` for ABR |
+| `persistQuality` | `boolean` | `true` | Persist quality preference to localStorage |
+| `storageKeyPrefix` | `string` | `"videojs-rewind:"` | Prefix for localStorage keys |
+| `storyboard` | `object` | `null` | Storyboard configuration (`fetchInfo`, `previewWidth`, `previewHeight`) |
+| `dvrWindowThreshold` | `number` | `120` | Seconds before rewind-to-VOD triggers |
+| `showToasts` | `boolean` | `true` | Show toast notifications |
+
+## Development
+
+```bash
+# Install dependencies
+bun install
+
+# Build
+bun run build
+
+# Test
+bun test
+```
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * videojs-rewind
+ * A Live DVR Rewind Plugin for video.js
+ *
+ * @license MIT
+ */
+import RewindPlugin from './plugin.js';
+export default RewindPlugin;
+export type { RewindPluginOptions } from './types.js';
+export { RewindPluginOptionsSchema } from './schema.js';