@rendley/sdk 1.12.6 → 1.12.7

package/dist/modules/clip/ClipStyle.d.ts

@@ -85,6 +85,8 @@ export declare class ClipStyle<T extends PIXI.Sprite = PIXI.Sprite> {
     setCornerRadius(radii: number | [number, number, number, number], relative?: boolean): void;
     getCornerRadius(): number[];
     getCornerRadiusRelative(): boolean;
+    setClipId(clipId: string): void;
+    getClipId(): string;
     setScale(scaleX: number, scaleY: number): void;
     getScale(): [number, number];
     setAnimationScaleMultiplier(multiplierX: number, multiplierY: number): void;

package/dist/modules/clip/clips/video/VideoClip.d.ts

@@ -14,6 +14,7 @@ export interface VideoClipOptions extends ClipOptions<ClipStyle> {
     volumeFadeInCurve?: FadeCurveEnum;
     volumeFadeOutDuration?: number;
     volumeFadeOutCurve?: FadeCurveEnum;
+    freezeTime?: number;
 }
 export declare class VideoClip extends Clip<PIXI.Sprite, ClipStyle<PIXI.Sprite>> {
     private videoElement;
@@ -27,6 +28,7 @@ export declare class VideoClip extends Clip<PIXI.Sprite, ClipStyle<PIXI.Sprite>>
     private volumeFadeInCurve;
     private volumeFadeOutDuration;
     private volumeFadeOutCurve;
+    private freezeTime?;
     private actions;
     private isProcessing;
     private lastUpdateTime;
@@ -140,6 +142,13 @@ export declare class VideoClip extends Clip<PIXI.Sprite, ClipStyle<PIXI.Sprite>>
      * or if the range is invalid, an empty array is returned.
      */
     getFilmstripDataRange(start: number, end: number): IFilmstripData[];
+    removeFreezeTime(): void;
+    setFreezeTime(time?: number): void;
+    getFreezeTime(): number | undefined;
+    extractFrameAsBase64Image(options?: {
+        mimeType: string;
+        quality: number;
+    }): Promise<string | null>;
     /**
      *
      * @deprecated Use getAudioSamples instead, don't forget to enable them in the settings
@@ -252,6 +261,7 @@ export declare class VideoClip extends Clip<PIXI.Sprite, ClipStyle<PIXI.Sprite>>
         }[] | undefined;
         volume?: number | undefined;
         muted?: boolean | undefined;
+        freezeTime?: number | undefined;
     };
     static deserialize(payload: object): VideoClip;
 }

package/dist/modules/effect/Effect.d.ts

@@ -4,21 +4,25 @@ export declare const EffectSchema: z.ZodObject<{
     id: z.ZodString;
     effectId: z.ZodString;
     provider: z.ZodString;
+    clipId: z.ZodOptional<z.ZodString>;
     properties: z.ZodArray<z.ZodTuple<[z.ZodString, z.ZodAny], null>, "many">;
 }, "strip", z.ZodTypeAny, {
     properties: [string, any][];
     id: string;
     provider: string;
     effectId: string;
+    clipId?: string | undefined;
 }, {
     properties: [string, any][];
     id: string;
     provider: string;
     effectId: string;
+    clipId?: string | undefined;
 }>;
 export declare class Effect {
     private id;
     private readonly effectId;
+    private clipId?;
     private provider;
     private effect;
     private readonly inputTextures;
@@ -32,6 +36,8 @@ export declare class Effect {
     getProperty(propertyName: string): any;
     getId(): string;
     setId(id: string): void;
+    setClipId(clipId: string): void;
+    getClipId(): string | undefined;
     getEffectId(): string;
     getProvider(): string;
     getIsBuiltIn(): boolean;
@@ -42,6 +48,7 @@ export declare class Effect {
         id: string;
         provider: string;
         effectId: string;
+        clipId?: string | undefined;
     };
     static deserialize(data: object): Effect;
 }

package/dist/modules/effect/built-in-effects/BuiltInChromaKey.d.ts

@@ -3,7 +3,8 @@ export declare enum BuiltInChromaKeyEffectPropertiesEnum {
     keyColor = "keyColor",
     similarity = "similarity",
     smoothness = "smoothness",
-    spill = "spill"
+    spill = "spill",
+    lumaWeight = "lumaWeight"
 }
 export declare class BuiltInChromaKeyEffect extends EffectBase {
     constructor(properties: Map<string, any>);

package/dist/modules/effect/built-in-effects/rendley/chroma-key/ChromaKeyFilter.d.ts

@@ -4,6 +4,7 @@ interface ChromaKeyOptions {
     similarity: number;
     smoothness: number;
     spill: number;
+    lumaWeight: number;
 }
 export declare class ChromaKeyFilter extends Filter {
     /** Default constructor options. */
@@ -37,5 +38,12 @@ export declare class ChromaKeyFilter extends Filter {
      */
     get spill(): number;
     set spill(value: number);
+    /**
+     * The luma weight for the keying effect.
+     * Higher values will remove more colors similar to the key color in brightness.
+     * @default 0.2
+     */
+    get lumaWeight(): number;
+    set lumaWeight(value: number);
 }
 export {};

package/dist/modules/event-emitter/types/EventEmitter.types.d.ts

@@ -11,6 +11,7 @@ export declare enum EventsEnum {
     LAYER_ADDED = "layer:added",
     LAYER_REMOVED = "layer:removed",
     LAYER_UPDATED = "layer:updated",
+    LAYER_PROPERTY_UPDATED = "layer:property:updated",
     LAYER_ERROR = "layer:error",
     LAYERS_ORDER_UPDATED = "layers:order:updated",
     TRANSITION_ADDED = "transition:added",
@@ -28,6 +29,7 @@ export declare enum EventsEnum {
     CLIP_FILTER_UPDATED = "clip:filter:updated",
     CLIP_EFFECT_ADDED = "clip:effect:added",
     CLIP_EFFECT_REMOVED = "clip:effect:removed",
+    CLIP_EFFECT_UPDATED = "clip:effect:updated",
     CLIP_LOTTIE_PROPERTY_UPDATED = "clip:lottie-property:updated",
     CLIP_ANIMATION_UPDATED = "clip:animation:updated",
     LIBRARY_ADDED = "library:added",
@@ -56,7 +58,6 @@ export declare enum EventsEnum {
     SUBTITLES_TEXTBLOCK_ADDED = "subtitles:textblock:added",
     SUBTITLES_TEXTBLOCK_REMOVED = "subtitles:textblock:removed",
     SUBTITLES_TEXTBLOCK_UPDATED = "subtitles:textblock:updated",
-    EFFECT_PROPERTY_CHANGED = "effect:property:changed",
     TRANSITION_PROPERTY_CHANGED = "transition:property:changed",
     FONT_ADDED = "font:added",
     FONT_REMOVED = "font:removed",
@@ -98,6 +99,11 @@ export type EventPayloadMap = {
     [EventsEnum.LAYER_UPDATED]: {
         layerId: string;
     };
+    [EventsEnum.LAYER_PROPERTY_UPDATED]: {
+        layerId: string;
+        property: string;
+        value: unknown;
+    };
     [EventsEnum.LAYER_ERROR]: {
         layerId: string;
         name: string;
@@ -254,7 +260,8 @@ export type EventPayloadMap = {
     [EventsEnum.LIBRARY_TRANSITION_REMOVED]: {
         transitionId: string;
     };
-    [EventsEnum.EFFECT_PROPERTY_CHANGED]: {
+    [EventsEnum.CLIP_EFFECT_UPDATED]: {
+        clipId: string;
         id: string;
         property: string;
         value: any;
@@ -287,10 +294,10 @@ export type EventPayloadMap = {
         canRedo: boolean;
     };
     [EventsEnum.UNDO_PERFORMED]: {
-        name: string;
+        group: UndoGroup;
     };
     [EventsEnum.REDO_PERFORMED]: {
-        name: string;
+        group: UndoGroup;
     };
     [EventsEnum.UNDO_PROCESS_CUSTOM]: {
         undoRecord: UndoRecord;

package/dist/modules/filmstrip-extractor/FilmstripExtractor.d.ts

@@ -15,6 +15,7 @@ export declare class FilmstripExtractor {
     private worker;
     private listeners;
     private done;
+    private destroyed;
     private _startTime;
     constructor();
     private createWorker;

package/dist/modules/font-registry/FontRegistry.d.ts

@@ -7,7 +7,7 @@ export declare class FontRegistry {
     fonts: IFontFaceDescriptor[];
     constructor();
     loadFromUrl(name: string, url: string, descriptors?: FontFaceDescriptors, customData?: Map<string, unknown>): Promise<void>;
-    loadFromCssUrl(name: string, cssUrl: string): Promise<void>;
+    loadFromCssUrl(name: string, cssUrl: string, customData?: Map<string, unknown>): Promise<void>;
     preloadHtmlTextFonts(): Promise<void>;
     private load;
     offload(fontFamily: string): void;

package/dist/modules/layer/Layer.d.ts

@@ -13,6 +13,7 @@ interface AddClipOptions {
 type ClipOptionsUnion = ClipOptions | ImageClipOptions | SvgClipOptions | AdjustmentClipOptions | VideoClipOptions | TextClipOptions | AudioClipOptions | GifClipOptions | ShapeClipOptions | HtmlTextClipOptions | LottieClipOptions;
 export declare const LayerSchema: z.ZodObject<{
     id: z.ZodString;
+    name: z.ZodOptional<z.ZodString>;
     visible: z.ZodOptional<z.ZodBoolean>;
     muted: z.ZodOptional<z.ZodBoolean>;
     volume: z.ZodOptional<z.ZodNumber>;
@@ -45,6 +46,7 @@ export declare const LayerSchema: z.ZodObject<{
         outDuration: number;
         transitionId: string;
     }>, "many">;
+    customData: z.ZodOptional<z.ZodArray<z.ZodTuple<[z.ZodString, z.ZodUnknown], null>, "many">>;
 }, "strip", z.ZodTypeAny, {
     id: string;
     transitions: {
@@ -58,9 +60,11 @@ export declare const LayerSchema: z.ZodObject<{
         transitionId: string;
     }[];
     clips: any[];
+    name?: string | undefined;
     visible?: boolean | undefined;
     muted?: boolean | undefined;
     volume?: number | undefined;
+    customData?: [string, unknown][] | undefined;
 }, {
     id: string;
     transitions: {
@@ -74,12 +78,15 @@ export declare const LayerSchema: z.ZodObject<{
         transitionId: string;
     }[];
     clips: any[];
+    name?: string | undefined;
     visible?: boolean | undefined;
     muted?: boolean | undefined;
     volume?: number | undefined;
+    customData?: [string, unknown][] | undefined;
 }>;
 export declare class Layer {
     id: string;
+    name: string;
     visible: boolean;
     muted: boolean;
     volume: number;
@@ -87,6 +94,7 @@ export declare class Layer {
     clips: Record<string, Clip>;
     transitions: Transition[];
     container: PIXI.Container;
+    protected customData?: Map<string, unknown>;
     constructor();
     init(): Promise<void>;
     destroy(): void;
@@ -99,6 +107,14 @@ export declare class Layer {
     isMuted(): boolean;
     setVisibility(visible: boolean): void;
     getVisibility(): boolean;
+    setCustomData(key: string, value: unknown, overwrite?: boolean): boolean;
+    getCustomData(key: string): unknown;
+    hasCustomData(key: string): boolean;
+    clearAllCustomData(): void;
+    setAllCustomData(data: Map<string, unknown>): void;
+    getAllCustomData(): Map<string, unknown> | undefined;
+    setName(name: string): void;
+    getName(): string;
     moveClipToLayer(clipId: string, newLayerId: string): void;
     splitClip(clipId: string, time: number): Promise<Clip | null>;
     addTransition(data: TransitionOptions | Transition): string;
@@ -112,7 +128,7 @@ export declare class Layer {
     getClips(): Record<string, Clip<PIXI.Sprite, import("../clip").ClipStyle<PIXI.Sprite>>>;
     getClipIds(): string[];
     getNextEmptySpace(startTime: number, endTime: number): number;
-    adjustClipsLayout(): void;
+    adjustClipsLayout(): boolean;
     setZIndex(zIndex: number): void;
     onPlay(currentTime: number): Promise<void>;
     onPause(currentTime: number): void;
@@ -135,9 +151,11 @@ export declare class Layer {
             transitionId: string;
         }[];
         clips: any[];
+        name?: string | undefined;
         visible?: boolean | undefined;
         muted?: boolean | undefined;
         volume?: number | undefined;
+        customData?: [string, unknown][] | undefined;
     };
     static _deserializeClip(clipData: any): Clip | null;
     static deserialize(data: object): Layer;

package/dist/modules/library/Library.d.ts

@@ -58,14 +58,17 @@ export declare const LibrarySchema: z.ZodObject<{
             text: z.ZodString;
             time: z.ZodNumber;
             duration: z.ZodNumber;
+            wordTimings: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;
         }, "strip", z.ZodTypeAny, {
             text: string;
             time: number;
             duration: number;
+            wordTimings?: number[] | undefined;
         }, {
             text: string;
             time: number;
             duration: number;
+            wordTimings?: number[] | undefined;
         }>, "many">;
     }, "strip", z.ZodTypeAny, {
         id: string;
@@ -75,6 +78,7 @@ export declare const LibrarySchema: z.ZodObject<{
             text: string;
             time: number;
             duration: number;
+            wordTimings?: number[] | undefined;
         }[];
     }, {
         id: string;
@@ -84,6 +88,7 @@ export declare const LibrarySchema: z.ZodObject<{
             text: string;
             time: number;
             duration: number;
+            wordTimings?: number[] | undefined;
         }[];
     }>, "many">;
     effects: z.ZodArray<z.ZodObject<{
@@ -275,6 +280,7 @@ export declare const LibrarySchema: z.ZodObject<{
             text: string;
             time: number;
             duration: number;
+            wordTimings?: number[] | undefined;
         }[];
     }[];
     transitions: {
@@ -343,6 +349,7 @@ export declare const LibrarySchema: z.ZodObject<{
             text: string;
             time: number;
             duration: number;
+            wordTimings?: number[] | undefined;
         }[];
     }[];
     transitions: {
@@ -478,6 +485,7 @@ export declare class Library {
                 text: string;
                 time: number;
                 duration: number;
+                wordTimings?: number[] | undefined;
             }[];
         }[];
         transitions: {

package/dist/modules/library/Subtitles.d.ts

@@ -3,14 +3,17 @@ export declare const TextBlockSchema: z.ZodObject<{
     text: z.ZodString;
     time: z.ZodNumber;
     duration: z.ZodNumber;
+    wordTimings: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;
 }, "strip", z.ZodTypeAny, {
     text: string;
     time: number;
     duration: number;
+    wordTimings?: number[] | undefined;
 }, {
     text: string;
     time: number;
     duration: number;
+    wordTimings?: number[] | undefined;
 }>;
 export declare const SubtitlesSchema: z.ZodObject<{
     id: z.ZodString;
@@ -20,14 +23,17 @@ export declare const SubtitlesSchema: z.ZodObject<{
         text: z.ZodString;
         time: z.ZodNumber;
         duration: z.ZodNumber;
+        wordTimings: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;
     }, "strip", z.ZodTypeAny, {
         text: string;
         time: number;
         duration: number;
+        wordTimings?: number[] | undefined;
     }, {
         text: string;
         time: number;
         duration: number;
+        wordTimings?: number[] | undefined;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
     id: string;
@@ -37,6 +43,7 @@ export declare const SubtitlesSchema: z.ZodObject<{
         text: string;
         time: number;
         duration: number;
+        wordTimings?: number[] | undefined;
     }[];
 }, {
     id: string;
@@ -46,12 +53,14 @@ export declare const SubtitlesSchema: z.ZodObject<{
         text: string;
         time: number;
         duration: number;
+        wordTimings?: number[] | undefined;
     }[];
 }>;
 export interface TextBlock {
     text: string;
     time: number;
     duration: number;
+    wordTimings?: number[];
 }
 interface SubtitlesOptions {
     language?: string;
@@ -87,6 +96,7 @@ export declare class Subtitles {
             text: string;
             time: number;
             duration: number;
+            wordTimings?: number[] | undefined;
         }[];
     };
     static deserialize(data: object): Subtitles;

package/dist/modules/storage/StorageController.d.ts

@@ -4,7 +4,7 @@ export declare class StorageController {
     constructor();
     addProvider(provider: StorageProviderBase): void;
     removeProvider(provider: StorageProviderBase): void;
-    getProviders(type?: StorageProviderTypeEnum): StorageProviderBase | StorageProviderBase[] | undefined;
+    getProviders(type?: StorageProviderTypeEnum): StorageProviderBase[];
     init(projectId: string): Promise<void>;
     destroy(): Promise<void>;
     beginBatch(): Promise<void>;

package/dist/modules/timeline/Timeline.d.ts

@@ -11,6 +11,7 @@ export declare const TimelineSchema: z.ZodObject<{
     fps: z.ZodNumber;
     layers: z.ZodArray<z.ZodObject<{
         id: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
         visible: z.ZodOptional<z.ZodBoolean>;
         muted: z.ZodOptional<z.ZodBoolean>;
         volume: z.ZodOptional<z.ZodNumber>;
@@ -43,6 +44,7 @@ export declare const TimelineSchema: z.ZodObject<{
             outDuration: number;
             transitionId: string;
         }>, "many">;
+        customData: z.ZodOptional<z.ZodArray<z.ZodTuple<[z.ZodString, z.ZodUnknown], null>, "many">>;
     }, "strip", z.ZodTypeAny, {
         id: string;
         transitions: {
@@ -56,9 +58,11 @@ export declare const TimelineSchema: z.ZodObject<{
             transitionId: string;
         }[];
         clips: any[];
+        name?: string | undefined;
         visible?: boolean | undefined;
         muted?: boolean | undefined;
         volume?: number | undefined;
+        customData?: [string, unknown][] | undefined;
     }, {
         id: string;
         transitions: {
@@ -72,9 +76,11 @@ export declare const TimelineSchema: z.ZodObject<{
             transitionId: string;
         }[];
         clips: any[];
+        name?: string | undefined;
         visible?: boolean | undefined;
         muted?: boolean | undefined;
         volume?: number | undefined;
+        customData?: [string, unknown][] | undefined;
     }>, "many">;
     fitDuration: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
     volume: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
@@ -95,9 +101,11 @@ export declare const TimelineSchema: z.ZodObject<{
             transitionId: string;
         }[];
         clips: any[];
+        name?: string | undefined;
         visible?: boolean | undefined;
         muted?: boolean | undefined;
         volume?: number | undefined;
+        customData?: [string, unknown][] | undefined;
     }[];
     fitDuration: number;
 }, {
@@ -116,9 +124,11 @@ export declare const TimelineSchema: z.ZodObject<{
             transitionId: string;
         }[];
         clips: any[];
+        name?: string | undefined;
         visible?: boolean | undefined;
         muted?: boolean | undefined;
         volume?: number | undefined;
+        customData?: [string, unknown][] | undefined;
     }[];
     fitDuration?: number | undefined;
     volume?: number | undefined;
@@ -166,7 +176,7 @@ export declare class Timeline {
     extractAudio(clip: string | Clip): AudioClip | undefined;
     alignTime(time: number, roundDirection?: AlignRoundEnum): number;
     getFrameNumberFromTime(time: number, roundDirection?: AlignRoundEnum): number;
-    adjustClipsLayout(): void;
+    adjustClipsLayout(): boolean;
     getFrameDuration(): number;
     getFps(): number;
     setFps(fps: number): void;
@@ -191,9 +201,11 @@ export declare class Timeline {
                 transitionId: string;
             }[];
             clips: any[];
+            name?: string | undefined;
             visible?: boolean | undefined;
             muted?: boolean | undefined;
             volume?: number | undefined;
+            customData?: [string, unknown][] | undefined;
         }[];
         fitDuration: number;
     };

package/dist/modules/undo/UndoManager.types.d.ts

@@ -68,6 +68,7 @@ export declare enum UndoActionEnum {
     FILTER_INTENSITY = "filter-intensity",
     EFFECT_ADD = "effect-add",
     EFFECT_REMOVE = "effect-remove",
+    EFFECT_PROPERTY_CHANGE = "effect-property-changed",
     SUBTITLES_TEXT_MODE = "subtitles-text-mode",
     SUBTITLES_MAIN_TEXT_STYLE = "subtitles-main-text-style",
     SUBTITLES_HIGHLIGHT_TEXT_STYLE = "subtitles-highlighted-text-style",
@@ -366,6 +367,12 @@ export type UndoActionMappings = {
         clipId: string;
         effect: any;
     };
+    [UndoActionEnum.EFFECT_PROPERTY_CHANGE]: {
+        clipId: string;
+        id: string;
+        property: string;
+        value: any;
+    };
     [UndoActionEnum.SUBTITLES_TEXT_MODE]: {
         prevTextMode: string;
         textMode: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rendley/sdk",
-  "version": "1.12.6",
+  "version": "1.12.7",
   "license": "LICENSE",
   "author": "Onix Technologies",
   "homepage": "https://rendleysdk.com",