@lightbird/core 0.7.0 → 0.8.0

package/dist/index.cjs

@@ -1614,6 +1614,36 @@ async function captureFrameAt(videoEl, timeSeconds, width = 160, height = 90) {
   });
 }
 
+// src/utils/frame-export.ts
+function exportVideoFrame(videoEl, options = {}) {
+  const { type = "image/png", quality, filter } = options;
+  const width = videoEl.videoWidth;
+  const height = videoEl.videoHeight;
+  if (!width || !height) return null;
+  const canvas = document.createElement("canvas");
+  canvas.width = width;
+  canvas.height = height;
+  const ctx = canvas.getContext("2d");
+  if (!ctx) return null;
+  try {
+    if (filter) ctx.filter = filter;
+    ctx.drawImage(videoEl, 0, 0, width, height);
+    return canvas.toDataURL(type, quality);
+  } catch {
+    return null;
+  }
+}
+function downloadDataUrl(dataUrl, filename) {
+  const a = document.createElement("a");
+  a.href = dataUrl;
+  a.download = filename;
+  a.click();
+}
+function frameExportFilename(extension = "png") {
+  const stamp = (/* @__PURE__ */ new Date()).toISOString().replace(/:/g, "-");
+  return `lightbird-screenshot-${stamp}.${extension}`;
+}
+
 // src/utils/keyboard-shortcuts.ts
 var DEFAULT_SHORTCUTS = [
   { action: "play-pause", label: "Play / Pause", defaultKey: " ", key: " " },
@@ -1773,9 +1803,12 @@ exports.configureLightBird = configureLightBird;
 exports.createOffsetVttUrl = createOffsetVttUrl;
 exports.createVideoPlayer = createVideoPlayer;
 exports.destroyWebTorrentClient = destroyWebTorrentClient;
+exports.downloadDataUrl = downloadDataUrl;
 exports.exportPlaylist = exportPlaylist;
+exports.exportVideoFrame = exportVideoFrame;
 exports.extractNativeMetadata = extractNativeMetadata;
 exports.formatShortcutKey = formatShortcutKey;
+exports.frameExportFilename = frameExportFilename;
 exports.getFFmpeg = getFFmpeg;
 exports.getLanguageName = getLanguageName;
 exports.getVideoFiles = getVideoFiles;

package/dist/index.d.cts

@@ -388,6 +388,51 @@ declare function captureVideoThumbnail(videoEl: HTMLVideoElement, atSeconds?: nu
  */
 declare function captureFrameAt(videoEl: HTMLVideoElement, timeSeconds: number, width?: number, height?: number): Promise<string | null>;
 
+/**
+ * Frame / screenshot export.
+ *
+ * Captures the currently displayed frame of a playing video element to an
+ * image and (optionally) triggers a browser download. Unlike the seek-hover
+ * preview in {@link ./video-thumbnail}, this grabs the frame *in place* at the
+ * video's native resolution without seeking, so it never disturbs playback.
+ */
+interface ExportFrameOptions {
+    /** Output image MIME type. Defaults to `"image/png"`. */
+    type?: string;
+    /** Quality (0–1) for lossy formats such as jpeg/webp. Ignored for png. */
+    quality?: number;
+    /**
+     * CSS `filter` string to bake into the exported image (e.g. the
+     * brightness/contrast filters applied to the video element). When omitted,
+     * the raw frame is captured.
+     */
+    filter?: string;
+}
+/**
+ * Capture the current frame of a video element at its native resolution.
+ *
+ * @param videoEl - The video element to capture from.
+ * @param options - Output format and an optional CSS filter to bake in.
+ * @returns An image data URL, or `null` if capture failed — no 2d context, the
+ *          video has no decoded dimensions yet, or the canvas is tainted by a
+ *          cross-origin source.
+ */
+declare function exportVideoFrame(videoEl: HTMLVideoElement, options?: ExportFrameOptions): string | null;
+/**
+ * Trigger a browser download of a data URL by synthesizing an anchor click.
+ *
+ * @param dataUrl - The data (or object) URL to download.
+ * @param filename - The suggested filename for the saved file.
+ */
+declare function downloadDataUrl(dataUrl: string, filename: string): void;
+/**
+ * Build a timestamped default filename for an exported frame.
+ *
+ * @param extension - File extension without a leading dot. Defaults to `"png"`.
+ * @returns e.g. `lightbird-screenshot-2026-05-30T12-00-00-000Z.png`.
+ */
+declare function frameExportFilename(extension?: string): string;
+
 type ShortcutAction = 'play-pause' | 'seek-forward-5' | 'seek-backward-5' | 'seek-forward-30' | 'seek-backward-30' | 'volume-up' | 'volume-down' | 'mute' | 'fullscreen' | 'next-item' | 'prev-item' | 'screenshot' | 'show-shortcuts' | 'next-chapter' | 'prev-chapter' | 'frame-step-forward' | 'frame-step-backward' | 'loop-toggle' | 'ab-loop-cycle';
 interface ShortcutBinding {
     action: ShortcutAction;
@@ -450,4 +495,4 @@ declare function resetFFmpeg(): void;
  */
 declare function getLanguageName(code?: string | null): string | undefined;
 
-export { ASSRenderer, type AudioTrack, type AudioTrackMeta, CancellationError, type Chapter, DEFAULT_SHORTCUTS, DEFAULT_TRACKERS, DISCLAIMER_KEY, FLAG_MAGNET_LINK, HLSPlayer, type HLSPlayerFile, type LightBirdConfig, MKVPlayer, type MKVPlayerFile, type MediaErrorType, type ParsedMediaError, type PlaylistItem, type ProcessedFile, ProgressEstimator, type QualityLevel, type ShortcutAction, type ShortcutBinding, SimplePlayer, type SimplePlayerFile, type Subtitle, SubtitleConverter, type SubtitleCue, type SubtitleTrackMeta, type TorrentStatus, UniversalSubtitleManager, VIDEO_EXTENSIONS, type VideoFilters, type VideoMetadata, type VideoPlayer, acceptDisclaimer, applyOffsetToVtt, captureFrameAt, captureVideoThumbnail, configureLightBird, createOffsetVttUrl, createVideoPlayer, destroyWebTorrentClient, exportPlaylist, extractNativeMetadata, formatShortcutKey, getFFmpeg, getLanguageName, getVideoFiles, getWebTorrentClient, hasAcceptedDisclaimer, initFeatureFlags, isHlsUrl, isInteractiveElement, isMagnetUri, isVideoFile, loadShortcuts, matchesShortcut, parseChaptersFromFFmpegLog, parseChaptersFromVtt, parseM3U8, parseMediaError, resetFFmpeg, saveShortcuts, validateFile };
+export { ASSRenderer, type AudioTrack, type AudioTrackMeta, CancellationError, type Chapter, DEFAULT_SHORTCUTS, DEFAULT_TRACKERS, DISCLAIMER_KEY, type ExportFrameOptions, FLAG_MAGNET_LINK, HLSPlayer, type HLSPlayerFile, type LightBirdConfig, MKVPlayer, type MKVPlayerFile, type MediaErrorType, type ParsedMediaError, type PlaylistItem, type ProcessedFile, ProgressEstimator, type QualityLevel, type ShortcutAction, type ShortcutBinding, SimplePlayer, type SimplePlayerFile, type Subtitle, SubtitleConverter, type SubtitleCue, type SubtitleTrackMeta, type TorrentStatus, UniversalSubtitleManager, VIDEO_EXTENSIONS, type VideoFilters, type VideoMetadata, type VideoPlayer, acceptDisclaimer, applyOffsetToVtt, captureFrameAt, captureVideoThumbnail, configureLightBird, createOffsetVttUrl, createVideoPlayer, destroyWebTorrentClient, downloadDataUrl, exportPlaylist, exportVideoFrame, extractNativeMetadata, formatShortcutKey, frameExportFilename, getFFmpeg, getLanguageName, getVideoFiles, getWebTorrentClient, hasAcceptedDisclaimer, initFeatureFlags, isHlsUrl, isInteractiveElement, isMagnetUri, isVideoFile, loadShortcuts, matchesShortcut, parseChaptersFromFFmpegLog, parseChaptersFromVtt, parseM3U8, parseMediaError, resetFFmpeg, saveShortcuts, validateFile };

package/dist/index.d.ts

@@ -388,6 +388,51 @@ declare function captureVideoThumbnail(videoEl: HTMLVideoElement, atSeconds?: nu
  */
 declare function captureFrameAt(videoEl: HTMLVideoElement, timeSeconds: number, width?: number, height?: number): Promise<string | null>;
 
+/**
+ * Frame / screenshot export.
+ *
+ * Captures the currently displayed frame of a playing video element to an
+ * image and (optionally) triggers a browser download. Unlike the seek-hover
+ * preview in {@link ./video-thumbnail}, this grabs the frame *in place* at the
+ * video's native resolution without seeking, so it never disturbs playback.
+ */
+interface ExportFrameOptions {
+    /** Output image MIME type. Defaults to `"image/png"`. */
+    type?: string;
+    /** Quality (0–1) for lossy formats such as jpeg/webp. Ignored for png. */
+    quality?: number;
+    /**
+     * CSS `filter` string to bake into the exported image (e.g. the
+     * brightness/contrast filters applied to the video element). When omitted,
+     * the raw frame is captured.
+     */
+    filter?: string;
+}
+/**
+ * Capture the current frame of a video element at its native resolution.
+ *
+ * @param videoEl - The video element to capture from.
+ * @param options - Output format and an optional CSS filter to bake in.
+ * @returns An image data URL, or `null` if capture failed — no 2d context, the
+ *          video has no decoded dimensions yet, or the canvas is tainted by a
+ *          cross-origin source.
+ */
+declare function exportVideoFrame(videoEl: HTMLVideoElement, options?: ExportFrameOptions): string | null;
+/**
+ * Trigger a browser download of a data URL by synthesizing an anchor click.
+ *
+ * @param dataUrl - The data (or object) URL to download.
+ * @param filename - The suggested filename for the saved file.
+ */
+declare function downloadDataUrl(dataUrl: string, filename: string): void;
+/**
+ * Build a timestamped default filename for an exported frame.
+ *
+ * @param extension - File extension without a leading dot. Defaults to `"png"`.
+ * @returns e.g. `lightbird-screenshot-2026-05-30T12-00-00-000Z.png`.
+ */
+declare function frameExportFilename(extension?: string): string;
+
 type ShortcutAction = 'play-pause' | 'seek-forward-5' | 'seek-backward-5' | 'seek-forward-30' | 'seek-backward-30' | 'volume-up' | 'volume-down' | 'mute' | 'fullscreen' | 'next-item' | 'prev-item' | 'screenshot' | 'show-shortcuts' | 'next-chapter' | 'prev-chapter' | 'frame-step-forward' | 'frame-step-backward' | 'loop-toggle' | 'ab-loop-cycle';
 interface ShortcutBinding {
     action: ShortcutAction;
@@ -450,4 +495,4 @@ declare function resetFFmpeg(): void;
  */
 declare function getLanguageName(code?: string | null): string | undefined;
 
-export { ASSRenderer, type AudioTrack, type AudioTrackMeta, CancellationError, type Chapter, DEFAULT_SHORTCUTS, DEFAULT_TRACKERS, DISCLAIMER_KEY, FLAG_MAGNET_LINK, HLSPlayer, type HLSPlayerFile, type LightBirdConfig, MKVPlayer, type MKVPlayerFile, type MediaErrorType, type ParsedMediaError, type PlaylistItem, type ProcessedFile, ProgressEstimator, type QualityLevel, type ShortcutAction, type ShortcutBinding, SimplePlayer, type SimplePlayerFile, type Subtitle, SubtitleConverter, type SubtitleCue, type SubtitleTrackMeta, type TorrentStatus, UniversalSubtitleManager, VIDEO_EXTENSIONS, type VideoFilters, type VideoMetadata, type VideoPlayer, acceptDisclaimer, applyOffsetToVtt, captureFrameAt, captureVideoThumbnail, configureLightBird, createOffsetVttUrl, createVideoPlayer, destroyWebTorrentClient, exportPlaylist, extractNativeMetadata, formatShortcutKey, getFFmpeg, getLanguageName, getVideoFiles, getWebTorrentClient, hasAcceptedDisclaimer, initFeatureFlags, isHlsUrl, isInteractiveElement, isMagnetUri, isVideoFile, loadShortcuts, matchesShortcut, parseChaptersFromFFmpegLog, parseChaptersFromVtt, parseM3U8, parseMediaError, resetFFmpeg, saveShortcuts, validateFile };
+export { ASSRenderer, type AudioTrack, type AudioTrackMeta, CancellationError, type Chapter, DEFAULT_SHORTCUTS, DEFAULT_TRACKERS, DISCLAIMER_KEY, type ExportFrameOptions, FLAG_MAGNET_LINK, HLSPlayer, type HLSPlayerFile, type LightBirdConfig, MKVPlayer, type MKVPlayerFile, type MediaErrorType, type ParsedMediaError, type PlaylistItem, type ProcessedFile, ProgressEstimator, type QualityLevel, type ShortcutAction, type ShortcutBinding, SimplePlayer, type SimplePlayerFile, type Subtitle, SubtitleConverter, type SubtitleCue, type SubtitleTrackMeta, type TorrentStatus, UniversalSubtitleManager, VIDEO_EXTENSIONS, type VideoFilters, type VideoMetadata, type VideoPlayer, acceptDisclaimer, applyOffsetToVtt, captureFrameAt, captureVideoThumbnail, configureLightBird, createOffsetVttUrl, createVideoPlayer, destroyWebTorrentClient, downloadDataUrl, exportPlaylist, exportVideoFrame, extractNativeMetadata, formatShortcutKey, frameExportFilename, getFFmpeg, getLanguageName, getVideoFiles, getWebTorrentClient, hasAcceptedDisclaimer, initFeatureFlags, isHlsUrl, isInteractiveElement, isMagnetUri, isVideoFile, loadShortcuts, matchesShortcut, parseChaptersFromFFmpegLog, parseChaptersFromVtt, parseM3U8, parseMediaError, resetFFmpeg, saveShortcuts, validateFile };

package/dist/index.js

@@ -1611,6 +1611,36 @@ async function captureFrameAt(videoEl, timeSeconds, width = 160, height = 90) {
   });
 }
 
+// src/utils/frame-export.ts
+function exportVideoFrame(videoEl, options = {}) {
+  const { type = "image/png", quality, filter } = options;
+  const width = videoEl.videoWidth;
+  const height = videoEl.videoHeight;
+  if (!width || !height) return null;
+  const canvas = document.createElement("canvas");
+  canvas.width = width;
+  canvas.height = height;
+  const ctx = canvas.getContext("2d");
+  if (!ctx) return null;
+  try {
+    if (filter) ctx.filter = filter;
+    ctx.drawImage(videoEl, 0, 0, width, height);
+    return canvas.toDataURL(type, quality);
+  } catch {
+    return null;
+  }
+}
+function downloadDataUrl(dataUrl, filename) {
+  const a = document.createElement("a");
+  a.href = dataUrl;
+  a.download = filename;
+  a.click();
+}
+function frameExportFilename(extension = "png") {
+  const stamp = (/* @__PURE__ */ new Date()).toISOString().replace(/:/g, "-");
+  return `lightbird-screenshot-${stamp}.${extension}`;
+}
+
 // src/utils/keyboard-shortcuts.ts
 var DEFAULT_SHORTCUTS = [
   { action: "play-pause", label: "Play / Pause", defaultKey: " ", key: " " },
@@ -1749,4 +1779,4 @@ function resetFFmpeg() {
   loading = null;
 }
 
-export { ASSRenderer, CancellationError, DEFAULT_SHORTCUTS, DEFAULT_TRACKERS, DISCLAIMER_KEY, FLAG_MAGNET_LINK, HLSPlayer, MKVPlayer, ProgressEstimator, SimplePlayer, SubtitleConverter, UniversalSubtitleManager, VIDEO_EXTENSIONS, acceptDisclaimer, applyOffsetToVtt, captureFrameAt, captureVideoThumbnail, configureLightBird, createOffsetVttUrl, createVideoPlayer, destroyWebTorrentClient, exportPlaylist, extractNativeMetadata, formatShortcutKey, getFFmpeg, getLanguageName, getVideoFiles, getWebTorrentClient, hasAcceptedDisclaimer, initFeatureFlags, isHlsUrl, isInteractiveElement, isMagnetUri, isVideoFile, loadShortcuts, matchesShortcut, parseChaptersFromFFmpegLog, parseChaptersFromVtt, parseM3U8, parseMediaError, resetFFmpeg, saveShortcuts, validateFile };
+export { ASSRenderer, CancellationError, DEFAULT_SHORTCUTS, DEFAULT_TRACKERS, DISCLAIMER_KEY, FLAG_MAGNET_LINK, HLSPlayer, MKVPlayer, ProgressEstimator, SimplePlayer, SubtitleConverter, UniversalSubtitleManager, VIDEO_EXTENSIONS, acceptDisclaimer, applyOffsetToVtt, captureFrameAt, captureVideoThumbnail, configureLightBird, createOffsetVttUrl, createVideoPlayer, destroyWebTorrentClient, downloadDataUrl, exportPlaylist, exportVideoFrame, extractNativeMetadata, formatShortcutKey, frameExportFilename, getFFmpeg, getLanguageName, getVideoFiles, getWebTorrentClient, hasAcceptedDisclaimer, initFeatureFlags, isHlsUrl, isInteractiveElement, isMagnetUri, isVideoFile, loadShortcuts, matchesShortcut, parseChaptersFromFFmpegLog, parseChaptersFromVtt, parseM3U8, parseMediaError, resetFFmpeg, saveShortcuts, validateFile };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightbird/core",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "Client-side video player engine. Plays MKV, MP4, WebM with full subtitle, audio track, and chapter support. No server required.",
   "license": "MIT",
   "author": "Punyam Singh",