@rendley/sdk 1.8.3 → 1.9.0

package/LICENSE

@@ -1,48 +1,48 @@
-Proprietary License Agreement
-
-1. Grant of License
-   Onix Technologies ("Licensor") hereby grants you ("Licensee") a non-exclusive, non-transferable, limited license to use the Rendley SDK ("Software") solely for the purpose of developing and integrating applications in accordance with the terms of this Agreement.
-
-2. Restrictions
-
-Licensee shall not:
-
-1. Modify, adapt, translate, or create derivative works of the Software without prior written consent from Licensor.
-2. Reverse engineer, decompile, disassemble, or otherwise attempt to discover the source code of the Software.
-3. Redistribute, sublicense, rent, lease, or lend the Software to any third party.
-4. Use the Software for any purpose that is illegal or prohibited by law.
-
-5. Intellectual Property Rights
-
-The Software is protected by copyright laws and international copyright treaties, as well as other intellectual property laws and treaties. All title, ownership rights, and intellectual property rights in and to the Software and all copies thereof are owned by Licensor.
-
-4. Fees and Payment
-   Licensee agrees to pay the license fees and any other charges incurred in connection with the use of the Software as specified in the order form or purchase agreement. All payments are non-refundable.
-
-5. Support and Updates
-   Licensor may, at its sole discretion, provide updates, enhancements, or modifications to the Software. Licensor is not obligated to provide any support services, updates, or enhancements unless a separate support agreement is entered into.
-
-6. Termination
-   This Agreement is effective until terminated. Licensee may terminate this Agreement at any time by destroying all copies of the Software in their possession. Licensor may terminate this Agreement if Licensee breaches any of the terms and conditions. Upon termination, Licensee must destroy all copies of the Software.
-
-7. Disclaimer of Warranties
-   THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. LICENSOR DOES NOT WARRANT THAT THE SOFTWARE WILL MEET LICENSEE'S REQUIREMENTS OR THAT THE OPERATION OF THE SOFTWARE WILL BE UNINTERRUPTED OR ERROR-FREE.
-
-8. Limitation of Liability
-   IN NO EVENT SHALL LICENSOR BE LIABLE FOR ANY INDIRECT, INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES, OR DAMAGES FOR LOSS OF PROFITS, REVENUE, DATA, OR USE, INCURRED BY LICENSEE OR ANY THIRD PARTY, WHETHER IN AN ACTION IN CONTRACT OR TORT, ARISING FROM LICENSEE'S ACCESS TO, OR USE OF, THE SOFTWARE.
-
-9. Governing Law
-   This Agreement shall be governed by and construed in accordance with the laws of Moldova, without regard to its conflict of laws principles.
-
-10. Entire Agreement
-    This Agreement constitutes the entire agreement between the parties with respect to the use of the Software and supersedes all prior or contemporaneous understandings regarding such subject matter. Any modifications to this Agreement must be in writing and signed by both parties.
-
-11. Severability
-    If any provision of this Agreement is held to be invalid or unenforceable, the remaining provisions will continue in full force and effect.
-
-12. No Waiver
-    The failure of either party to enforce any right or provision of this Agreement will not be deemed a waiver of such right or provision.
-
-Onix Technologies
-Chisinau, MD-2072
-Moldova
+Proprietary License Agreement
+
+1. Grant of License
+   Onix Technologies ("Licensor") hereby grants you ("Licensee") a non-exclusive, non-transferable, limited license to use the Rendley SDK ("Software") solely for the purpose of developing and integrating applications in accordance with the terms of this Agreement.
+
+2. Restrictions
+
+Licensee shall not:
+
+1. Modify, adapt, translate, or create derivative works of the Software without prior written consent from Licensor.
+2. Reverse engineer, decompile, disassemble, or otherwise attempt to discover the source code of the Software.
+3. Redistribute, sublicense, rent, lease, or lend the Software to any third party.
+4. Use the Software for any purpose that is illegal or prohibited by law.
+
+5. Intellectual Property Rights
+
+The Software is protected by copyright laws and international copyright treaties, as well as other intellectual property laws and treaties. All title, ownership rights, and intellectual property rights in and to the Software and all copies thereof are owned by Licensor.
+
+4. Fees and Payment
+   Licensee agrees to pay the license fees and any other charges incurred in connection with the use of the Software as specified in the order form or purchase agreement. All payments are non-refundable.
+
+5. Support and Updates
+   Licensor may, at its sole discretion, provide updates, enhancements, or modifications to the Software. Licensor is not obligated to provide any support services, updates, or enhancements unless a separate support agreement is entered into.
+
+6. Termination
+   This Agreement is effective until terminated. Licensee may terminate this Agreement at any time by destroying all copies of the Software in their possession. Licensor may terminate this Agreement if Licensee breaches any of the terms and conditions. Upon termination, Licensee must destroy all copies of the Software.
+
+7. Disclaimer of Warranties
+   THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. LICENSOR DOES NOT WARRANT THAT THE SOFTWARE WILL MEET LICENSEE'S REQUIREMENTS OR THAT THE OPERATION OF THE SOFTWARE WILL BE UNINTERRUPTED OR ERROR-FREE.
+
+8. Limitation of Liability
+   IN NO EVENT SHALL LICENSOR BE LIABLE FOR ANY INDIRECT, INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES, OR DAMAGES FOR LOSS OF PROFITS, REVENUE, DATA, OR USE, INCURRED BY LICENSEE OR ANY THIRD PARTY, WHETHER IN AN ACTION IN CONTRACT OR TORT, ARISING FROM LICENSEE'S ACCESS TO, OR USE OF, THE SOFTWARE.
+
+9. Governing Law
+   This Agreement shall be governed by and construed in accordance with the laws of Moldova, without regard to its conflict of laws principles.
+
+10. Entire Agreement
+    This Agreement constitutes the entire agreement between the parties with respect to the use of the Software and supersedes all prior or contemporaneous understandings regarding such subject matter. Any modifications to this Agreement must be in writing and signed by both parties.
+
+11. Severability
+    If any provision of this Agreement is held to be invalid or unenforceable, the remaining provisions will continue in full force and effect.
+
+12. No Waiver
+    The failure of either party to enforce any right or provision of this Agreement will not be deemed a waiver of such right or provision.
+
+Onix Technologies
+Chisinau, MD-2072
+Moldova

package/README.md

@@ -1,40 +1,40 @@
-# Rendley SDK
-
-Rendley SDK takes the complexity out of video editing by providing a comprehensive set of APIs that handle composition, effects, filters, playback, rendering, splitting, trimming, and more.
-
-To achieve maximum performance, we leverage WebGL for rendering and WebCodecs API for hardware-accelerated encoding and decoding. For browsers that don't support [WebCodecs API](https://caniuse.com/?search=webcodecs), we seamlessly fallback to a browser-based version of FFmpeg.
-
-## Installation
-
-### Prerequisites
-
-To use Rendley SDK, ensure that your website includes the following headers to enable [SharedArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer) functionality:
-
-```
-Cross-Origin-Embedder-Policy: credentialless
-Cross-Origin-Opener-Policy: same-origin
-```
-
-### Using the NPM Registry
-
-The installation process is straightforward. Simply run one of the followin
-
-```bash
-npm install @rendley/sdk
-```
-
-or
-
-```bash
-yarn add @rendley/sdk
-```
-
-The package includes type definitions, so you don't need to worry about setting those up separately.
-
-## Getting Started
-
-Check out the [documentation](https://docs.rendley.com) to learn more about how to get started creating compositions and building your own video editing software.
-
-## Templates
-
-To further simplify the process, we have [pre-built interfaces](https://docs.rendley.com/video-editor) that allow you to embed our video editing capabilities onto your website with just a few lines of code.
+# Rendley SDK
+
+Rendley SDK takes the complexity out of video editing by providing a comprehensive set of APIs that handle composition, effects, filters, playback, rendering, splitting, trimming, and more.
+
+To achieve maximum performance, we leverage WebGL for rendering and WebCodecs API for hardware-accelerated encoding and decoding. For browsers that don't support [WebCodecs API](https://caniuse.com/?search=webcodecs), we seamlessly fallback to a browser-based version of FFmpeg.
+
+## Installation
+
+### Prerequisites
+
+To use Rendley SDK, ensure that your website includes the following headers to enable [SharedArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer) functionality:
+
+```
+Cross-Origin-Embedder-Policy: credentialless
+Cross-Origin-Opener-Policy: same-origin
+```
+
+### Using the NPM Registry
+
+The installation process is straightforward. Simply run one of the followin
+
+```bash
+npm install @rendley/sdk
+```
+
+or
+
+```bash
+yarn add @rendley/sdk
+```
+
+The package includes type definitions, so you don't need to worry about setting those up separately.
+
+## Getting Started
+
+Check out the [documentation](https://docs.rendley.com) to learn more about how to get started creating compositions and building your own video editing software.
+
+## Templates
+
+To further simplify the process, we have [pre-built interfaces](https://docs.rendley.com/video-editor) that allow you to embed our video editing capabilities onto your website with just a few lines of code.

package/dist/Engine.d.ts

@@ -4,7 +4,7 @@ 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 { Settings, VideoCodec } from "./modules/settings";
 import { StorageProviderBase } from "./modules/storage";
 import { StorageController } from "./modules/storage/StorageController";
 import { SubtitlesManager } from "./modules/subtitles";
@@ -44,20 +44,23 @@ type CustomClipConstructor<T extends CustomClip = CustomClip> = {
 };
 export declare class Engine {
     private static instance?;
+    static readonly currentVersion = "0.1.2";
+    static projectVersion: string;
     private display;
     private timeline;
     private library;
-    private fontRegistry;
+    private readonly fontRegistry;
     private subtitlesManager;
-    private undoManager;
-    private storageController;
+    private readonly undoManager;
+    private readonly storageController;
     private settings;
     readonly events: EventEmitter;
     private initialized;
-    private rendering;
     private license?;
     private projectId;
     private isDestroying;
+    private createdAt;
+    private readonly renderer;
     private constructor();
     static getInstance(): Engine;
     hasInstance(): boolean;
@@ -76,7 +79,6 @@ export declare class Engine {
     getStorageController(): StorageController;
     isInitialized(): boolean;
     isRendering(): boolean;
-    private generateMix;
     export(payload?: ExportOptions): Promise<ExportResult | null>;
     play(): Promise<void>;
     pause(): Promise<void>;
@@ -84,7 +86,7 @@ export declare class Engine {
     seek(value: number): Promise<void>;
     getRenderer(): import("./modules/display/renderer/PixiRenderer").PixiRenderer;
     getRendererStage(): PIXI.Container<PIXI.DisplayObject> | null;
-    getClipById(clipId: string): import("./modules/clip").Clip<PIXI.Sprite, import("./modules/clip").ClipStyle<PIXI.Sprite>> | undefined;
+    getClipById(clipId: string): import(".").Clip<PIXI.Sprite, import(".").ClipStyle<PIXI.Sprite>> | undefined;
     getClipsIdsForPoint(x: number, y: number): null;
     setSubtitles(subtitlesId: string, offset: number): void;
     shouldSplitAudio(): boolean;
@@ -144,46 +146,63 @@ export declare class Engine {
             }[];
         };
         version?: string | undefined;
+        createdAt?: number | undefined;
         projectId?: string | undefined;
         subtitlesManager?: {
-            textMode: "full" | "partial";
+            scale: number;
+            textMode: "partial" | "full";
             highlightAnimation: import("./modules/subtitles").HighlightAnimationEnum;
             highlightAnimationSpeed: number;
             mainTextStyle: {
                 color: string;
+                strokeColor: string;
                 fontSize: number;
                 fontWeight: "bold" | "normal" | "bolder" | "lighter" | "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900";
                 fontFamily: string;
                 fontStyle: "normal" | "italic" | "oblique";
                 backgroundColor: string;
-                backgroundPadding: number;
-                backgroundCornerRadius: number;
                 strokeThickness: number;
-                strokeColor: string;
-                padding: number;
                 wordWrapWidth: number;
+                padding: number;
                 wordWrap: boolean;
+                backgroundPadding: number;
+                backgroundCornerRadius: number;
                 leading: number;
             };
             highlightTextStyle: {
                 color: string;
+                strokeColor: string;
                 fontSize: number;
                 fontWeight: "bold" | "normal" | "bolder" | "lighter" | "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900";
                 fontFamily: string;
                 fontStyle: "normal" | "italic" | "oblique";
                 backgroundColor: string;
-                backgroundPadding: number;
-                backgroundCornerRadius: number;
                 strokeThickness: number;
-                strokeColor: string;
                 padding: number;
+                backgroundPadding: number;
+                backgroundCornerRadius: number;
             };
+            position?: [number, number] | undefined;
         } | undefined;
         settings?: {
             decoderPreferredAcceleration: import("./modules/settings").PreferredAcceleration;
             encoderPreferredAcceleration: import("./modules/settings").PreferredAcceleration;
             m3u8MaxResolution: [number, number];
-            showRenderPreview: boolean;
+            renderShowPreview: boolean;
+            renderMaxQueueSize: number;
+            renderThrottleFactor: number;
+            encoderCodec: VideoCodec;
+            encoderUseWebCodecs: boolean;
+            encoderUseAlpha: boolean;
+            encoderBitrate: number;
+            encoderBitrateMode: import("./modules/settings").BitrateMode;
+            encoderPerformanceMode: import("./modules/settings").PerformanceMode;
+            encoderDeadline: number;
+            encoderCrf: number;
+            encoderForcedCodecRFCString: string;
+            subtitlesScaleOnResize: boolean;
+            subtitlesAutoWrapOnResize: boolean;
+            viewAutoLayoutOnResize: import("./modules/settings").AutoLayoutMode;
         } | undefined;
     };
     static deserialize(data: object): Promise<Engine | undefined>;