@rendley/sdk 1.9.7 → 1.10.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -9
- package/dist/Engine.d.ts +10 -4
- package/dist/index.cjs +1 -1
- package/dist/index.js +1 -1
- package/dist/libs/ffmpeg/classes.d.ts +2 -1
- package/dist/libs/ffmpeg/const.d.ts +1 -0
- package/dist/libs/ffmpeg/types.d.ts +6 -1
- package/dist/modules/background-timer/background-timer-worker.d.ts +5 -0
- package/dist/modules/background-timer/background-timer.d.ts +9 -0
- package/dist/modules/background-timer/backround-timer.types.d.ts +15 -0
- package/dist/modules/clip/Clip.d.ts +6 -3
- package/dist/modules/clip/ClipStyle.d.ts +3 -3
- package/dist/modules/clip/clips/audio/AudioClip.d.ts +1 -1
- package/dist/modules/clip/clips/custom/CustomClip.d.ts +1 -1
- package/dist/modules/clip/clips/htmlText/HtmlTextClip.d.ts +1 -1
- package/dist/modules/clip/clips/index.d.ts +1 -0
- package/dist/modules/clip/clips/lottie/LottieClip.d.ts +116 -36
- package/dist/modules/clip/clips/shape/ShapeClip.d.ts +6 -10
- package/dist/modules/clip/clips/shape/ShapeSprite.d.ts +3 -9
- package/dist/modules/clip/clips/shape/ShapeStyle.d.ts +58 -9
- package/dist/modules/clip/clips/shape/types/Shape.types.d.ts +7 -0
- package/dist/modules/clip/clips/text/TextClip.d.ts +1 -1
- package/dist/modules/clip/clips/text/TextStyle.d.ts +8 -8
- package/dist/modules/clip/clips/video/VideoClip.d.ts +1 -1
- package/dist/modules/ffmpeg/FFmpeg.d.ts +1 -1
- package/dist/modules/layer/Layer.d.ts +5 -5
- package/dist/modules/library/Library.d.ts +5 -5
- package/dist/modules/library/MediaData.d.ts +4 -3
- package/dist/modules/renderer/Renderer.d.ts +4 -0
- package/dist/modules/subtitles/SubtitleManager.d.ts +4 -4
- package/dist/modules/timeline/Timeline.d.ts +7 -7
- package/dist/modules/transition/Transition.d.ts +3 -3
- package/dist/modules/undo/UndoManager.types.d.ts +51 -0
- package/dist/types/clip.types.d.ts +2 -5
- package/dist/utils/compareVersions/compareVersions.d.ts +1 -0
- package/dist/utils/timer/performanceTimer.d.ts +3 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,15 +6,6 @@ To achieve maximum performance, we leverage WebGL for rendering and WebCodecs AP
|
|
|
6
6
|
|
|
7
7
|
## Installation
|
|
8
8
|
|
|
9
|
-
### Prerequisites
|
|
10
|
-
|
|
11
|
-
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:
|
|
12
|
-
|
|
13
|
-
```
|
|
14
|
-
Cross-Origin-Embedder-Policy: credentialless
|
|
15
|
-
Cross-Origin-Opener-Policy: same-origin
|
|
16
|
-
```
|
|
17
|
-
|
|
18
9
|
### Using the NPM Registry
|
|
19
10
|
|
|
20
11
|
The installation process is straightforward. Simply run one of the followin
|
package/dist/Engine.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import * as PIXI from "pixi.js";
|
|
2
|
+
import { BackgroundTimer } from "./modules/background-timer/background-timer";
|
|
2
3
|
import { CustomClip } from "./modules/clip/clips/custom/CustomClip";
|
|
3
4
|
import { Display, DisplayOptions } from "./modules/display/Display";
|
|
4
5
|
import { EventEmitter } from "./modules/event-emitter";
|
|
@@ -46,11 +47,12 @@ type CustomClipConstructor<T extends CustomClip = CustomClip> = {
|
|
|
46
47
|
};
|
|
47
48
|
export declare class Engine {
|
|
48
49
|
private static instance?;
|
|
49
|
-
static readonly currentVersion
|
|
50
|
+
static readonly currentVersion: string;
|
|
50
51
|
static projectVersion: string;
|
|
51
52
|
private static queuedDeserializeData;
|
|
52
53
|
private static isDeserializing;
|
|
53
54
|
private static deserializationPromise?;
|
|
55
|
+
private static safariHackAudioContext?;
|
|
54
56
|
private display;
|
|
55
57
|
private timeline;
|
|
56
58
|
private library;
|
|
@@ -67,13 +69,16 @@ export declare class Engine {
|
|
|
67
69
|
private isDestroying;
|
|
68
70
|
private createdAt;
|
|
69
71
|
private readonly renderer;
|
|
72
|
+
private readonly backgroundTimer;
|
|
70
73
|
private constructor();
|
|
71
74
|
static getInstance(): Engine;
|
|
72
75
|
hasInstance(): boolean;
|
|
73
76
|
getFFmpeg(): import("./libs/ffmpeg").FFmpeg;
|
|
77
|
+
private checkSafariAudioHack;
|
|
74
78
|
init(options: EngineOptions): Promise<void>;
|
|
75
79
|
private getLicenseCredentials;
|
|
76
80
|
destroy(everything?: boolean): Promise<void>;
|
|
81
|
+
getBackgroundTimer(): BackgroundTimer;
|
|
77
82
|
getProjectId(): string;
|
|
78
83
|
setProjectId(id: string): Promise<void>;
|
|
79
84
|
getDisplay(): Display;
|
|
@@ -105,6 +110,7 @@ export declare class Engine {
|
|
|
105
110
|
callStaticCustomClipMethod(typeEnum: string, methodName: string, ...args: any[]): any;
|
|
106
111
|
createCustomClipInstance<T extends CustomClip = CustomClip>(typeEnum: string, ...args: any[]): T;
|
|
107
112
|
hasCustomClipType(typeEnum: string): boolean;
|
|
113
|
+
reset(): void;
|
|
108
114
|
serialize(): {
|
|
109
115
|
display: {
|
|
110
116
|
width: number;
|
|
@@ -117,9 +123,9 @@ export declare class Engine {
|
|
|
117
123
|
layers: {
|
|
118
124
|
id: string;
|
|
119
125
|
transitions: {
|
|
126
|
+
type: "transition";
|
|
120
127
|
name: string;
|
|
121
128
|
id: string;
|
|
122
|
-
type: "transition";
|
|
123
129
|
startClipId: string;
|
|
124
130
|
endClipId: string;
|
|
125
131
|
inDuration: number;
|
|
@@ -145,8 +151,8 @@ export declare class Engine {
|
|
|
145
151
|
}[];
|
|
146
152
|
}[];
|
|
147
153
|
media: {
|
|
148
|
-
id: string;
|
|
149
154
|
type: string;
|
|
155
|
+
id: string;
|
|
150
156
|
filename: string;
|
|
151
157
|
permanentUrl?: string | undefined;
|
|
152
158
|
hash?: string | undefined;
|
|
@@ -159,7 +165,7 @@ export declare class Engine {
|
|
|
159
165
|
projectId?: string | undefined;
|
|
160
166
|
subtitlesManager?: {
|
|
161
167
|
scale: number;
|
|
162
|
-
textMode: "
|
|
168
|
+
textMode: "full" | "partial";
|
|
163
169
|
highlightAnimation: import("./modules/subtitles").HighlightAnimationEnum;
|
|
164
170
|
highlightAnimationSpeed: number;
|
|
165
171
|
mainTextStyle: {
|