@rendley/sdk 1.3.0 → 1.4.0

package/dist/Engine.d.ts

@@ -4,14 +4,29 @@ 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 { 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;
@@ -28,6 +43,7 @@ export declare class Engine {
     private fontRegistry;
     private subtitlesManager;
     private storageController;
+    private settings;
     readonly events: EventEmitter;
     private initialized;
     private rendering;
@@ -43,13 +59,14 @@ export declare class Engine {
     getDisplay(): Display;
     getTimeline(): Timeline;
     getLibrary(): Library;
+    getSettings(): Settings;
     getFontRegistry(): FontRegistry;
     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>;
@@ -60,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;
@@ -90,6 +108,7 @@ export declare class Engine {
                     transitionSrc: string;
                 }[];
             }[];
+            fitDuration: number;
         };
         library: {
             subtitles: {
@@ -109,6 +128,7 @@ export declare class Engine {
                 permanentUrl?: string | undefined;
                 hash?: string | undefined;
                 mimeType?: string | undefined;
+                customData?: [string, unknown][] | undefined;
             }[];
         };
         subtitlesManager: {
@@ -118,7 +138,7 @@ export declare class Engine {
             mainTextStyle: {
                 fontSize?: number | undefined;
                 color?: string | undefined;
-                fontWeight?: "bold" | "normal" | "bolder" | "lighter" | "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900" | 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;
@@ -128,7 +148,7 @@ export declare class Engine {
             highlightTextStyle: {
                 color?: string | undefined;
                 fontSize?: number | undefined;
-                fontWeight?: "bold" | "normal" | "bolder" | "lighter" | "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900" | 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;
@@ -139,6 +159,10 @@ export declare class Engine {
         };
         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>;
 }