captions.js 0.4.1 → 0.4.2

package/dist/index.d.mts

@@ -1,3 +1,5 @@
+import Konva from 'konva';
+
 /**
  * Whitelisted Google Fonts that the renderer knows how to lazy-load.
  *
@@ -50,6 +52,10 @@ interface StylePreset {
         fitLayoutAspectRatio: string;
     };
 }
+/**
+ * Names of all available style presets.
+ */
+type StylePresetName = "Karaoke" | "Beasty" | "Safari" | "Acid" | "Popline" | "Desert" | "Hook" | "Sky" | "Flamingo" | "Deep Diver B&W" | "New" | "Banger" | "Catchy" | "Karaoke 2" | "Karaoke 3" | "From" | "Classic" | "Classic Big" | "Crazy" | "Acid 2" | "Marvel" | "Lovly" | "Old Money" | "Cinema" | "Marker";
 /**
  * Curated set of presets that ship with captions.js out of the box.
  *
@@ -220,6 +226,26 @@ type CaptionsInstance = Captions;
  */
 declare function captionsjs(options: CaptionsOptions): Captions;
 
+declare enum LayoutType {
+    'Fill' = "fill",
+    'Fit' = "fit",
+    'Split' = "split",
+    'Three' = "three",
+    'Four' = "four",
+    'ScreenShare' = "screenShare"
+}
+type AspectRatioType = typeof aspectRatios[number];
+interface LayoutSettings {
+    aspectRatio: AspectRatioType;
+    aIAutoLayout: LayoutType[];
+    fitLayoutCropAspectRatio: AspectRatioType;
+}
+declare const aspectRatios: readonly ["1:1", "9:16", "16:9"];
+
+type RenderFrameFn = (captionsSettings: CaptionsSettings, layoutSettings: LayoutSettings, captions: Caption[], currentTime: number, targetSize: [number, number], layer: Konva.Layer, toCoef?: number, debug?: boolean) => void;
+
+declare const renderFrame: RenderFrameFn;
+
 /**
  * Simple canvas demo renderer used only for the docs playground.
  *
@@ -233,4 +259,4 @@ declare function captionsjs(options: CaptionsOptions): Captions;
  */
 declare function renderCaptions(ctx: CanvasRenderingContext2D, text: string): boolean;
 
-export { type Caption, Captions, type CaptionsInstance, type CaptionsOptions, type CaptionsSettings, type StylePreset, captionsjs, captionsjs as default, googleFontsList, renderCaptions, renderString, stylePresets };
+export { type Caption, Captions, type CaptionsInstance, type CaptionsOptions, type CaptionsSettings, type StylePreset, type StylePresetName, captionsjs, captionsjs as default, googleFontsList, renderCaptions, renderFrame, renderString, stylePresets };

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import Konva from 'konva';
+
 /**
  * Whitelisted Google Fonts that the renderer knows how to lazy-load.
  *
@@ -50,6 +52,10 @@ interface StylePreset {
         fitLayoutAspectRatio: string;
     };
 }
+/**
+ * Names of all available style presets.
+ */
+type StylePresetName = "Karaoke" | "Beasty" | "Safari" | "Acid" | "Popline" | "Desert" | "Hook" | "Sky" | "Flamingo" | "Deep Diver B&W" | "New" | "Banger" | "Catchy" | "Karaoke 2" | "Karaoke 3" | "From" | "Classic" | "Classic Big" | "Crazy" | "Acid 2" | "Marvel" | "Lovly" | "Old Money" | "Cinema" | "Marker";
 /**
  * Curated set of presets that ship with captions.js out of the box.
  *
@@ -220,6 +226,26 @@ type CaptionsInstance = Captions;
  */
 declare function captionsjs(options: CaptionsOptions): Captions;
 
+declare enum LayoutType {
+    'Fill' = "fill",
+    'Fit' = "fit",
+    'Split' = "split",
+    'Three' = "three",
+    'Four' = "four",
+    'ScreenShare' = "screenShare"
+}
+type AspectRatioType = typeof aspectRatios[number];
+interface LayoutSettings {
+    aspectRatio: AspectRatioType;
+    aIAutoLayout: LayoutType[];
+    fitLayoutCropAspectRatio: AspectRatioType;
+}
+declare const aspectRatios: readonly ["1:1", "9:16", "16:9"];
+
+type RenderFrameFn = (captionsSettings: CaptionsSettings, layoutSettings: LayoutSettings, captions: Caption[], currentTime: number, targetSize: [number, number], layer: Konva.Layer, toCoef?: number, debug?: boolean) => void;
+
+declare const renderFrame: RenderFrameFn;
+
 /**
  * Simple canvas demo renderer used only for the docs playground.
  *
@@ -233,4 +259,4 @@ declare function captionsjs(options: CaptionsOptions): Captions;
  */
 declare function renderCaptions(ctx: CanvasRenderingContext2D, text: string): boolean;
 
-export { type Caption, Captions, type CaptionsInstance, type CaptionsOptions, type CaptionsSettings, type StylePreset, captionsjs, captionsjs as default, googleFontsList, renderCaptions, renderString, stylePresets };
+export { type Caption, Captions, type CaptionsInstance, type CaptionsOptions, type CaptionsSettings, type StylePreset, type StylePresetName, captionsjs, captionsjs as default, googleFontsList, renderCaptions, renderFrame, renderString, stylePresets };

package/dist/index.js

@@ -35,6 +35,7 @@ __export(index_exports, {
   default: () => index_default,
   googleFontsList: () => googleFontsList,
   renderCaptions: () => renderCaptions,
+  renderFrame: () => renderFrame,
   renderString: () => renderString,
   stylePresets: () => stylePresets
 });
@@ -1795,6 +1796,7 @@ var index_default = captionsjs;
   captionsjs,
   googleFontsList,
   renderCaptions,
+  renderFrame,
   renderString,
   stylePresets
 });

package/dist/index.mjs

@@ -1753,6 +1753,7 @@ export {
   index_default as default,
   googleFontsList,
   renderCaptions,
+  renderFrame,
   renderString,
   stylePresets
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "captions.js",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "private": false,
   "license": "MIT",
   "repository": {