@rendley/sdk 1.2.2 → 1.4.0

package/dist/Engine.d.ts

@@ -4,15 +4,33 @@ import { Display, DisplayOptions } from "./modules/display/Display";
 import { EventEmitter } from "./modules/event-emitter";
 import { FontRegistry } from "./modules/font-registry";
 import { Library } from "./modules/library";
-import { SubtitleManager } from "./modules/subtitleManager";
+import { Settings } from "./modules/settings";
+import { StorageProviderBase } from "./modules/storage";
+import { StorageController } from "./modules/storage/StorageController";
+import { SubtitlesManager } from "./modules/subtitleManager";
 import { Timeline } from "./modules/timeline/Timeline";
+export declare enum ExportVideoType {
+    VIDEO_ONLY = "video_only",
+    AUDIO_ONLY = "audio_only",
+    VIDEO_AUDIO = "video_audio"
+}
 interface EngineLicense {
     licenseName: string;
     licenseKey: string;
 }
+interface ExportResult {
+    blob: Blob;
+    extension: "aac" | "mp4";
+}
+interface ExportOptions {
+    type?: ExportVideoType;
+    from?: number;
+    to?: number;
+}
 export interface EngineOptions {
     display?: DisplayOptions;
     license?: EngineLicense;
+    storages?: StorageProviderBase[];
 }
 type CustomClipConstructor<T extends CustomClip = CustomClip> = {
     new (...args: any[]): T;
@@ -23,25 +41,32 @@ export declare class Engine {
     private timeline;
     private library;
     private fontRegistry;
-    private subtitleManager;
+    private subtitlesManager;
+    private storageController;
+    private settings;
     readonly events: EventEmitter;
     private initialized;
     private rendering;
     private license?;
+    private projectId;
     private constructor();
     static getInstance(): Engine;
+    hasInstance(): boolean;
     getFFmpeg(): import("./libs/ffmpeg").FFmpeg;
     init(options: EngineOptions): Promise<void>;
     destroy(): void;
+    getProjectId(): string;
     getDisplay(): Display;
     getTimeline(): Timeline;
     getLibrary(): Library;
+    getSettings(): Settings;
     getFontRegistry(): FontRegistry;
-    getSubtitlesManager(): SubtitleManager;
+    getSubtitlesManager(): SubtitlesManager;
+    getStorageController(): StorageController;
     isInitialized(): boolean;
     isRendering(): boolean;
     private generateMix;
-    export(path: string): Promise<Blob>;
+    export(payload?: ExportOptions): Promise<ExportResult>;
     play(): Promise<void>;
     pause(): Promise<void>;
     stop(): Promise<void>;
@@ -52,6 +77,7 @@ export declare class Engine {
     getClipsIdsForPoint(x: number, y: number): null;
     setSubtitles(subtitlesId: string, offset: number): void;
     shouldSplitAudio(): boolean;
+    getFrameAsBase64Image(time?: number, mimeType?: "image/jpeg" | "image/webp" | "image/png", quality?: number): Promise<string>;
     customClipTypes: Map<string, CustomClipConstructor>;
     registerCustomClip<T extends CustomClip = CustomClip>(classType: CustomClipConstructor<T>, typeEnum: string): void;
     callStaticCustomClipMethod(typeEnum: string, methodName: string, ...args: any[]): any;
@@ -82,6 +108,7 @@ export declare class Engine {
                     transitionSrc: string;
                 }[];
             }[];
+            fitDuration: number;
         };
         library: {
             subtitles: {
@@ -99,9 +126,43 @@ export declare class Engine {
                 id: string;
                 filename: string;
                 permanentUrl?: string | undefined;
+                hash?: string | undefined;
+                mimeType?: string | undefined;
+                customData?: [string, unknown][] | undefined;
             }[];
         };
+        subtitlesManager: {
+            textMode: "full" | "partial";
+            highlightAnimation: import("./modules/subtitleManager").HighlightAnimationEnum;
+            highlightAnimationSpeed: number;
+            mainTextStyle: {
+                fontSize?: number | undefined;
+                color?: string | undefined;
+                fontWeight?: "normal" | "bold" | "bolder" | "lighter" | "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900" | undefined;
+                fontFamily?: string | undefined;
+                fontStyle?: "normal" | "italic" | "oblique" | undefined;
+                wordWrapWidth?: number | null | undefined;
+                strokeThickness?: number | undefined;
+                strokeColor?: string | undefined;
+            };
+            highlightTextStyle: {
+                color?: string | undefined;
+                fontSize?: number | undefined;
+                fontWeight?: "normal" | "bold" | "bolder" | "lighter" | "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900" | undefined;
+                fontFamily?: string | undefined;
+                fontStyle?: "normal" | "italic" | "oblique" | undefined;
+                backgroundColor?: string | undefined;
+                backgroundPadding?: number | undefined;
+                strokeThickness?: number | undefined;
+                strokeColor?: string | undefined;
+            };
+        };
         version?: string | undefined;
+        projectId?: string | undefined;
+        settings?: {
+            preferredDecodingAcceleration: import("./modules/settings").PreferredAcceleration;
+            preferredEncodingAcceleration: import("./modules/settings").PreferredAcceleration;
+        } | undefined;
     };
     static deserialize(data: object): Promise<Engine | undefined>;
 }