@pixerate/editor 0.230.0 → 0.231.0

package/dist/video-editor/parse.d.ts

@@ -1,8 +1,8 @@
 import { type VideoAnimatable, type VideoKeyframes } from './keyframes.js';
-import { type VideoClipMask, type VideoAsset, type VideoAssetProxy, type VideoClip, type VideoClipEffect, type VideoEffectRef, type VideoEffectValues, type VideoClipAnimation, type VideoGrade, type VideoGradeLut, type VideoMarker, type VideoProject, type VideoSequence, type VideoTrack, type VideoTranscriptWord, type VideoTransform, type VideoTransition } from './types.js';
+import { type VideoClipMask, type VideoClipCamera, type VideoAsset, type VideoAssetProxy, type VideoClip, type VideoClipEffect, type VideoEffectRef, type VideoEffectValues, type VideoClipAnimation, type VideoGrade, type VideoGradeLut, type VideoMarker, type VideoProject, type VideoSequence, type VideoTrack, type VideoTranscriptWord, type VideoTransform, type VideoTransition } from './types.js';
 /**
- * Keyframes `{ keys: [{ t, v, ease }] }`: at least one key, in strictly increasing time (clip-relative
- * ms), each value within `range`.
+ * Keyframes `{ keys: [{ t, v, ease }] }`: at least one key, in time order (clip-relative ms; two
+ * at one time make a jump), each value within `range`.
  */
 export declare function parseVideoKeyframes(v: unknown, path: string, { min, max }?: {
     min?: number;
@@ -35,6 +35,8 @@ export declare function parseVideoClipEffects(v: unknown, path: string): VideoCl
 export declare function parseVideoTranscriptWords(v: unknown, path: string): VideoTranscriptWord[] | undefined;
 export declare function parseVideoAsset(v: unknown, path?: string): VideoAsset;
 export declare function parseVideoAssetProxies(v: unknown, path: string): VideoAssetProxy[] | undefined;
+/** A clip's camera moves `{ in, during, from, framing, base }` (see `VideoClipCamera`). */
+export declare function parseVideoClipCamera(v: unknown, path: string): VideoClipCamera | undefined;
 export declare function parseVideoClip(v: unknown, path?: string): VideoClip;
 export declare function parseVideoTrack(v: unknown, path?: string): VideoTrack;
 /** A nested sequence `{ id, name, tracks }` (see `VideoSequence`). */

package/dist/video-editor/tools.d.cts

@@ -69,6 +69,7 @@ export declare function describeVideoSequence(project: VideoProject, sequence: V
             transition?: import("./types.cjs").VideoTransition;
             effects?: import("./types.cjs").VideoClipEffect[];
             mask?: import("./types.cjs").VideoClipMask;
+            camera?: import("./types.cjs").VideoClipCamera;
         } | {
             source?: {
                 in: number;
@@ -98,6 +99,7 @@ export declare function describeVideoSequence(project: VideoProject, sequence: V
             transition?: import("./types.cjs").VideoTransition;
             effects?: import("./types.cjs").VideoClipEffect[];
             mask?: import("./types.cjs").VideoClipMask;
+            camera?: import("./types.cjs").VideoClipCamera;
         } | {
             source?: {
                 in: number;
@@ -122,6 +124,7 @@ export declare function describeVideoSequence(project: VideoProject, sequence: V
             transition?: import("./types.cjs").VideoTransition;
             effects?: import("./types.cjs").VideoClipEffect[];
             mask?: import("./types.cjs").VideoClipMask;
+            camera?: import("./types.cjs").VideoClipCamera;
         } | {
             source?: {
                 in: number;
@@ -151,6 +154,7 @@ export declare function describeVideoSequence(project: VideoProject, sequence: V
             transition?: import("./types.cjs").VideoTransition;
             effects?: import("./types.cjs").VideoClipEffect[];
             mask?: import("./types.cjs").VideoClipMask;
+            camera?: import("./types.cjs").VideoClipCamera;
         } | {
             source?: {
                 in: number;
@@ -174,6 +178,7 @@ export declare function describeVideoSequence(project: VideoProject, sequence: V
             transition?: import("./types.cjs").VideoTransition;
             effects?: import("./types.cjs").VideoClipEffect[];
             mask?: import("./types.cjs").VideoClipMask;
+            camera?: import("./types.cjs").VideoClipCamera;
             effect: string;
             provider?: string;
             values?: import("./types.cjs").VideoEffectValues;
@@ -202,6 +207,7 @@ export declare function describeVideoSequence(project: VideoProject, sequence: V
             transition?: import("./types.cjs").VideoTransition;
             effects?: import("./types.cjs").VideoClipEffect[];
             mask?: import("./types.cjs").VideoClipMask;
+            camera?: import("./types.cjs").VideoClipCamera;
         })[];
         volume?: number | undefined;
         syncLocked?: boolean | undefined;
@@ -286,6 +292,7 @@ export declare function describeVideoProject(project: VideoProject): {
                 transition?: import("./types.cjs").VideoTransition;
                 effects?: import("./types.cjs").VideoClipEffect[];
                 mask?: import("./types.cjs").VideoClipMask;
+                camera?: import("./types.cjs").VideoClipCamera;
             } | {
                 source?: {
                     in: number;
@@ -315,6 +322,7 @@ export declare function describeVideoProject(project: VideoProject): {
                 transition?: import("./types.cjs").VideoTransition;
                 effects?: import("./types.cjs").VideoClipEffect[];
                 mask?: import("./types.cjs").VideoClipMask;
+                camera?: import("./types.cjs").VideoClipCamera;
             } | {
                 source?: {
                     in: number;
@@ -339,6 +347,7 @@ export declare function describeVideoProject(project: VideoProject): {
                 transition?: import("./types.cjs").VideoTransition;
                 effects?: import("./types.cjs").VideoClipEffect[];
                 mask?: import("./types.cjs").VideoClipMask;
+                camera?: import("./types.cjs").VideoClipCamera;
             } | {
                 source?: {
                     in: number;
@@ -368,6 +377,7 @@ export declare function describeVideoProject(project: VideoProject): {
                 transition?: import("./types.cjs").VideoTransition;
                 effects?: import("./types.cjs").VideoClipEffect[];
                 mask?: import("./types.cjs").VideoClipMask;
+                camera?: import("./types.cjs").VideoClipCamera;
             } | {
                 source?: {
                     in: number;
@@ -391,6 +401,7 @@ export declare function describeVideoProject(project: VideoProject): {
                 transition?: import("./types.cjs").VideoTransition;
                 effects?: import("./types.cjs").VideoClipEffect[];
                 mask?: import("./types.cjs").VideoClipMask;
+                camera?: import("./types.cjs").VideoClipCamera;
                 effect: string;
                 provider?: string;
                 values?: import("./types.cjs").VideoEffectValues;
@@ -419,6 +430,7 @@ export declare function describeVideoProject(project: VideoProject): {
                 transition?: import("./types.cjs").VideoTransition;
                 effects?: import("./types.cjs").VideoClipEffect[];
                 mask?: import("./types.cjs").VideoClipMask;
+                camera?: import("./types.cjs").VideoClipCamera;
             })[];
             volume?: number | undefined;
             syncLocked?: boolean | undefined;
@@ -523,6 +535,7 @@ export declare function describeVideoProject(project: VideoProject): {
             transition?: import("./types.cjs").VideoTransition;
             effects?: import("./types.cjs").VideoClipEffect[];
             mask?: import("./types.cjs").VideoClipMask;
+            camera?: import("./types.cjs").VideoClipCamera;
         } | {
             source?: {
                 in: number;
@@ -552,6 +565,7 @@ export declare function describeVideoProject(project: VideoProject): {
             transition?: import("./types.cjs").VideoTransition;
             effects?: import("./types.cjs").VideoClipEffect[];
             mask?: import("./types.cjs").VideoClipMask;
+            camera?: import("./types.cjs").VideoClipCamera;
         } | {
             source?: {
                 in: number;
@@ -576,6 +590,7 @@ export declare function describeVideoProject(project: VideoProject): {
             transition?: import("./types.cjs").VideoTransition;
             effects?: import("./types.cjs").VideoClipEffect[];
             mask?: import("./types.cjs").VideoClipMask;
+            camera?: import("./types.cjs").VideoClipCamera;
         } | {
             source?: {
                 in: number;
@@ -605,6 +620,7 @@ export declare function describeVideoProject(project: VideoProject): {
             transition?: import("./types.cjs").VideoTransition;
             effects?: import("./types.cjs").VideoClipEffect[];
             mask?: import("./types.cjs").VideoClipMask;
+            camera?: import("./types.cjs").VideoClipCamera;
         } | {
             source?: {
                 in: number;
@@ -628,6 +644,7 @@ export declare function describeVideoProject(project: VideoProject): {
             transition?: import("./types.cjs").VideoTransition;
             effects?: import("./types.cjs").VideoClipEffect[];
             mask?: import("./types.cjs").VideoClipMask;
+            camera?: import("./types.cjs").VideoClipCamera;
             effect: string;
             provider?: string;
             values?: import("./types.cjs").VideoEffectValues;
@@ -656,6 +673,7 @@ export declare function describeVideoProject(project: VideoProject): {
             transition?: import("./types.cjs").VideoTransition;
             effects?: import("./types.cjs").VideoClipEffect[];
             mask?: import("./types.cjs").VideoClipMask;
+            camera?: import("./types.cjs").VideoClipCamera;
         })[];
         volume?: number | undefined;
         syncLocked?: boolean | undefined;

package/dist/video-editor/tools.d.ts

@@ -69,6 +69,7 @@ export declare function describeVideoSequence(project: VideoProject, sequence: V
             transition?: import("./types.js").VideoTransition;
             effects?: import("./types.js").VideoClipEffect[];
             mask?: import("./types.js").VideoClipMask;
+            camera?: import("./types.js").VideoClipCamera;
         } | {
             source?: {
                 in: number;
@@ -98,6 +99,7 @@ export declare function describeVideoSequence(project: VideoProject, sequence: V
             transition?: import("./types.js").VideoTransition;
             effects?: import("./types.js").VideoClipEffect[];
             mask?: import("./types.js").VideoClipMask;
+            camera?: import("./types.js").VideoClipCamera;
         } | {
             source?: {
                 in: number;
@@ -122,6 +124,7 @@ export declare function describeVideoSequence(project: VideoProject, sequence: V
             transition?: import("./types.js").VideoTransition;
             effects?: import("./types.js").VideoClipEffect[];
             mask?: import("./types.js").VideoClipMask;
+            camera?: import("./types.js").VideoClipCamera;
         } | {
             source?: {
                 in: number;
@@ -151,6 +154,7 @@ export declare function describeVideoSequence(project: VideoProject, sequence: V
             transition?: import("./types.js").VideoTransition;
             effects?: import("./types.js").VideoClipEffect[];
             mask?: import("./types.js").VideoClipMask;
+            camera?: import("./types.js").VideoClipCamera;
         } | {
             source?: {
                 in: number;
@@ -174,6 +178,7 @@ export declare function describeVideoSequence(project: VideoProject, sequence: V
             transition?: import("./types.js").VideoTransition;
             effects?: import("./types.js").VideoClipEffect[];
             mask?: import("./types.js").VideoClipMask;
+            camera?: import("./types.js").VideoClipCamera;
             effect: string;
             provider?: string;
             values?: import("./types.js").VideoEffectValues;
@@ -202,6 +207,7 @@ export declare function describeVideoSequence(project: VideoProject, sequence: V
             transition?: import("./types.js").VideoTransition;
             effects?: import("./types.js").VideoClipEffect[];
             mask?: import("./types.js").VideoClipMask;
+            camera?: import("./types.js").VideoClipCamera;
         })[];
         volume?: number | undefined;
         syncLocked?: boolean | undefined;
@@ -286,6 +292,7 @@ export declare function describeVideoProject(project: VideoProject): {
                 transition?: import("./types.js").VideoTransition;
                 effects?: import("./types.js").VideoClipEffect[];
                 mask?: import("./types.js").VideoClipMask;
+                camera?: import("./types.js").VideoClipCamera;
             } | {
                 source?: {
                     in: number;
@@ -315,6 +322,7 @@ export declare function describeVideoProject(project: VideoProject): {
                 transition?: import("./types.js").VideoTransition;
                 effects?: import("./types.js").VideoClipEffect[];
                 mask?: import("./types.js").VideoClipMask;
+                camera?: import("./types.js").VideoClipCamera;
             } | {
                 source?: {
                     in: number;
@@ -339,6 +347,7 @@ export declare function describeVideoProject(project: VideoProject): {
                 transition?: import("./types.js").VideoTransition;
                 effects?: import("./types.js").VideoClipEffect[];
                 mask?: import("./types.js").VideoClipMask;
+                camera?: import("./types.js").VideoClipCamera;
             } | {
                 source?: {
                     in: number;
@@ -368,6 +377,7 @@ export declare function describeVideoProject(project: VideoProject): {
                 transition?: import("./types.js").VideoTransition;
                 effects?: import("./types.js").VideoClipEffect[];
                 mask?: import("./types.js").VideoClipMask;
+                camera?: import("./types.js").VideoClipCamera;
             } | {
                 source?: {
                     in: number;
@@ -391,6 +401,7 @@ export declare function describeVideoProject(project: VideoProject): {
                 transition?: import("./types.js").VideoTransition;
                 effects?: import("./types.js").VideoClipEffect[];
                 mask?: import("./types.js").VideoClipMask;
+                camera?: import("./types.js").VideoClipCamera;
                 effect: string;
                 provider?: string;
                 values?: import("./types.js").VideoEffectValues;
@@ -419,6 +430,7 @@ export declare function describeVideoProject(project: VideoProject): {
                 transition?: import("./types.js").VideoTransition;
                 effects?: import("./types.js").VideoClipEffect[];
                 mask?: import("./types.js").VideoClipMask;
+                camera?: import("./types.js").VideoClipCamera;
             })[];
             volume?: number | undefined;
             syncLocked?: boolean | undefined;
@@ -523,6 +535,7 @@ export declare function describeVideoProject(project: VideoProject): {
             transition?: import("./types.js").VideoTransition;
             effects?: import("./types.js").VideoClipEffect[];
             mask?: import("./types.js").VideoClipMask;
+            camera?: import("./types.js").VideoClipCamera;
         } | {
             source?: {
                 in: number;
@@ -552,6 +565,7 @@ export declare function describeVideoProject(project: VideoProject): {
             transition?: import("./types.js").VideoTransition;
             effects?: import("./types.js").VideoClipEffect[];
             mask?: import("./types.js").VideoClipMask;
+            camera?: import("./types.js").VideoClipCamera;
         } | {
             source?: {
                 in: number;
@@ -576,6 +590,7 @@ export declare function describeVideoProject(project: VideoProject): {
             transition?: import("./types.js").VideoTransition;
             effects?: import("./types.js").VideoClipEffect[];
             mask?: import("./types.js").VideoClipMask;
+            camera?: import("./types.js").VideoClipCamera;
         } | {
             source?: {
                 in: number;
@@ -605,6 +620,7 @@ export declare function describeVideoProject(project: VideoProject): {
             transition?: import("./types.js").VideoTransition;
             effects?: import("./types.js").VideoClipEffect[];
             mask?: import("./types.js").VideoClipMask;
+            camera?: import("./types.js").VideoClipCamera;
         } | {
             source?: {
                 in: number;
@@ -628,6 +644,7 @@ export declare function describeVideoProject(project: VideoProject): {
             transition?: import("./types.js").VideoTransition;
             effects?: import("./types.js").VideoClipEffect[];
             mask?: import("./types.js").VideoClipMask;
+            camera?: import("./types.js").VideoClipCamera;
             effect: string;
             provider?: string;
             values?: import("./types.js").VideoEffectValues;
@@ -656,6 +673,7 @@ export declare function describeVideoProject(project: VideoProject): {
             transition?: import("./types.js").VideoTransition;
             effects?: import("./types.js").VideoClipEffect[];
             mask?: import("./types.js").VideoClipMask;
+            camera?: import("./types.js").VideoClipCamera;
         })[];
         volume?: number | undefined;
         syncLocked?: boolean | undefined;

package/dist/video-editor/types.d.cts

@@ -6,7 +6,7 @@
  * track draws over one on a later track. Clips on one track never overlap.
  */
 import type { VideoAnimatable, VideoKeyframes } from './keyframes.cjs';
-import type { EffectValue } from '../effects/types.cjs';
+import type { CameraMoveSpec, EffectValue } from '../effects/types.cjs';
 export type VideoAssetKind = 'video' | 'audio' | 'image';
 /** A spoken word in an asset's transcript, timed in the source (ms). */
 export interface VideoTranscriptWord {
@@ -230,6 +230,42 @@ interface VideoClipBase {
     effects?: VideoClipEffect[];
     /** A shape that cuts the picture out (see `VideoClipMask`). */
     mask?: VideoClipMask;
+    /** Provider camera moves baked into the transform's keyframes (see `VideoClipCamera`). */
+    camera?: VideoClipCamera;
+}
+/**
+ * Where a camera looks at a clip's picture: `zoom` × the picture as placed (default 1), centred
+ * on the point `x`, `y` pixels from the frame's centre (default 0, 0).
+ */
+export interface VideoCameraFraming {
+    zoom?: number;
+    x?: number;
+    y?: number;
+}
+/**
+ * Camera moves from the effects provider played on a clip, the clip being the shot: `in` (a
+ * `transition` move, such as a glide or whip pan) moves from `from` to `framing` over its `ms`
+ * from the clip's start, and `during` (a `hold` move, such as a Ken Burns drift) plays across the
+ * rest of the clip at `framing`. They are baked into the clip's x, y, scale and rotation keys
+ * (one per frame, two at a cut), so previews, renders and exports play them without the provider;
+ * `base` keeps the transform from before, put back when the moves are cleared. Set them with
+ * `VideoEditorController.setClipCameraMove`, which bakes them; edit the keys directly and the
+ * moves no longer describe them.
+ */
+export interface VideoClipCamera {
+    in?: CameraMoveSpec;
+    during?: CameraMoveSpec;
+    /** Where `in` starts (default the whole picture). */
+    from?: VideoCameraFraming;
+    /** Where `in` arrives and `during` plays (default the whole picture). */
+    framing?: VideoCameraFraming;
+    /** The clip's transform before the moves were baked. */
+    base: {
+        x?: number;
+        y?: number;
+        scale?: number;
+        rotation?: number;
+    };
 }
 /**
  * The shape of a clip mask: `rectangle` (with `cornerRadius`), `ellipse`, `linear` (a straight

package/dist/video-editor/types.d.ts

@@ -6,7 +6,7 @@
  * track draws over one on a later track. Clips on one track never overlap.
  */
 import type { VideoAnimatable, VideoKeyframes } from './keyframes.js';
-import type { EffectValue } from '../effects/types.js';
+import type { CameraMoveSpec, EffectValue } from '../effects/types.js';
 export type VideoAssetKind = 'video' | 'audio' | 'image';
 /** A spoken word in an asset's transcript, timed in the source (ms). */
 export interface VideoTranscriptWord {
@@ -230,6 +230,42 @@ interface VideoClipBase {
     effects?: VideoClipEffect[];
     /** A shape that cuts the picture out (see `VideoClipMask`). */
     mask?: VideoClipMask;
+    /** Provider camera moves baked into the transform's keyframes (see `VideoClipCamera`). */
+    camera?: VideoClipCamera;
+}
+/**
+ * Where a camera looks at a clip's picture: `zoom` × the picture as placed (default 1), centred
+ * on the point `x`, `y` pixels from the frame's centre (default 0, 0).
+ */
+export interface VideoCameraFraming {
+    zoom?: number;
+    x?: number;
+    y?: number;
+}
+/**
+ * Camera moves from the effects provider played on a clip, the clip being the shot: `in` (a
+ * `transition` move, such as a glide or whip pan) moves from `from` to `framing` over its `ms`
+ * from the clip's start, and `during` (a `hold` move, such as a Ken Burns drift) plays across the
+ * rest of the clip at `framing`. They are baked into the clip's x, y, scale and rotation keys
+ * (one per frame, two at a cut), so previews, renders and exports play them without the provider;
+ * `base` keeps the transform from before, put back when the moves are cleared. Set them with
+ * `VideoEditorController.setClipCameraMove`, which bakes them; edit the keys directly and the
+ * moves no longer describe them.
+ */
+export interface VideoClipCamera {
+    in?: CameraMoveSpec;
+    during?: CameraMoveSpec;
+    /** Where `in` starts (default the whole picture). */
+    from?: VideoCameraFraming;
+    /** Where `in` arrives and `during` plays (default the whole picture). */
+    framing?: VideoCameraFraming;
+    /** The clip's transform before the moves were baked. */
+    base: {
+        x?: number;
+        y?: number;
+        scale?: number;
+        rotation?: number;
+    };
 }
 /**
  * The shape of a clip mask: `rectangle` (with `cornerRadius`), `ellipse`, `linear` (a straight

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pixerate/editor",
-  "version": "0.230.0",
+  "version": "0.231.0",
   "description": "UI-agnostic rich text and media editing core library",
   "author": "Pixerate",
   "license": "MIT",