@pixerate/editor 0.61.0 → 0.63.0

package/dist/animation-editor/index.d.cts

@@ -36,6 +36,10 @@ interface MotionScene {
      * per second ("on twos" at 12), for a hand-drawn look. Default: smooth.
      */
     steps?: number;
+    /** A beat grid to cue shots to (`MotionShot.at.beat`): music or a voiceover's rhythm. */
+    beat?: MotionBeatGrid;
+    /** A voiceover's words with their times, to cue shots to (`MotionShot.at.word`). */
+    narration?: MotionNarration;
     /** Wanted length in seconds `[min, max]`; `check` warns outside it. */
     target?: [number, number];
     /** Parameters a Flair effect made from this scene exposes (see `toFlairVectorEffect`). */
@@ -63,6 +67,31 @@ type MotionCamera = (MotionRect | {
     /** Zoom at a steady rate (the size changes by the same factor each moment) instead of linearly. */
     geometric?: boolean;
 };
+/** A steady beat: `bpm` beats a minute, the first at `offset` ms, `meter` beats a bar. */
+interface MotionBeatGrid {
+    bpm: number;
+    /** When beat 0 falls, ms (default 0). */
+    offset?: number;
+    /** Beats in a bar (default 4), for reading beats as bar and beat. */
+    meter?: number;
+}
+/** A voiceover: its words in order, each with when it is said (ms), from a TTS or speech-to-text word timing. */
+interface MotionNarration {
+    words: {
+        text: string;
+        start: number;
+        end?: number;
+    }[];
+}
+/** When a shot is cued to start: on a beat, on a narration word, or at a time. */
+interface MotionCue {
+    /** Beat number on the scene's beat grid, from 0 (fractions for off-beats: 2.5 is the "and" of beat 3). */
+    beat?: number;
+    /** Index of a word in the scene's narration, from 0. */
+    word?: number;
+    /** A time in ms. */
+    ms?: number;
+}
 /** One beat of the animation. */
 interface MotionShot {
     /** Stable id (unique in the scene), e.g. `intro`. */
@@ -71,10 +100,21 @@ interface MotionShot {
     label?: string;
     /** Omit to keep the current framing. */
     camera?: MotionCamera;
+    /**
+     * Start on a cue: a beat, a narration word or a time. The shot before holds until then; a
+     * cue that comes before the shot before has ended is missed (`check` says by how much).
+     * Give one of `beat`, `word` or `ms`.
+     */
+    at?: MotionCue;
     /** Commands, played one after another (unless a command says `with: "previous"`). */
     run: MotionCommand[];
     /** Milliseconds to hold after the commands finish (default 600). */
     hold?: number;
+    /**
+     * Plays the whole shot this many times as fast (default 1): its camera move, delays,
+     * durations, staggers and hold all scale by 1 / speed. `fit_animation` sets it to fit a length.
+     */
+    speed?: number;
 }
 /** Fields every command takes. */
 interface MotionCommandBase {
@@ -492,6 +532,14 @@ declare const MOTION_ISSUE_CODES: {
         readonly severity: "warning";
         readonly wording: "A spring is given a duration shorter than it takes to settle, so it jumps to its end.";
     };
+    readonly 'unknown-cue': {
+        readonly severity: "error";
+        readonly wording: "A shot is cued to a beat with no beat grid, or to a word the narration does not have.";
+    };
+    readonly 'cue-missed': {
+        readonly severity: "warning";
+        readonly wording: "A shot starts after its cue, because the shot before runs past it.";
+    };
     readonly 'scene-too-long': {
         readonly severity: "warning";
         readonly wording: "The scene runs past its target length.";
@@ -626,6 +674,10 @@ interface MotionShotTiming {
     /** When the last command ends (the hold follows). */
     commandsEnd: number;
     end: number;
+    /** The time the shot is cued to start (`at`), when it has a cue that resolves. */
+    cue?: number;
+    /** How late the shot starts after its cue (ms), when the shot before ran past it. */
+    missedBy?: number;
 }
 interface MotionCommandTiming {
     shot: string;
@@ -730,6 +782,18 @@ declare function fitMotionRect(rect: MotionRect, aspect: number): MotionRect;
 declare function resolveMotionCamera(camera: MotionCamera, scene: MotionScene): MotionRect | null;
 /** Length of a node's outline (its longest path for a group), in document units. */
 declare function motionPathLength(node: VectorNode, parentWorld?: AffineMatrix): number;
+/** How much a shot's `speed` stretches its time (1 / speed; 1 when unset or not above 0). */
+declare function motionShotTimeScale(shot: MotionShot): number;
+/** When beat `beat` falls on a grid, ms: `offset + beat · 60000 / bpm`. */
+declare function motionBeatTime(grid: MotionBeatGrid, beat: number): number;
+/** The beat (fractional) at `ms` on a grid, and its bar and beat in the bar (both from 1). */
+declare function motionBeatAt(grid: MotionBeatGrid, ms: number): {
+    beat: number;
+    bar: number;
+    beatInBar: number;
+};
+/** The time a cue names, ms, or undefined when it names a beat with no grid or a word the narration lacks. */
+declare function motionCueTime(scene: Pick<MotionScene, 'beat' | 'narration'>, cue: MotionCue): number | undefined;
 /** How many times a command plays (1 for `enter`, `exit` and `wait`, which do not repeat). */
 declare function motionCommandRepeat(command: MotionCommand): number;
 /** How long one target of a command takes (ms), every repeat included. */
@@ -868,6 +932,8 @@ type MotionEdit = {
     loop?: MotionScene['loop'];
     fps?: number;
     steps?: number | null;
+    beat?: MotionScene['beat'] | null;
+    narration?: MotionScene['narration'] | null;
     target?: [number, number] | null;
 } | {
     op: 'insert_shots';
@@ -877,7 +943,7 @@ type MotionEdit = {
     op: 'update_shot';
     shot: string;
     set?: Partial<MotionShot>;
-    remove?: ('label' | 'camera' | 'hold')[];
+    remove?: ('label' | 'camera' | 'hold' | 'speed' | 'at')[];
 } | {
     op: 'delete_shots';
     shots: string[];
@@ -931,6 +997,27 @@ declare function applyMotionEdits(scene: MotionScene, edits: MotionEdit | readon
 /** An empty scene over `artwork`. */
 declare function createMotionScene(artwork: VectorDocument, init?: Partial<Omit<MotionScene, 'artwork' | 'version'>>): MotionScene;
 
+interface MotionFitOptions {
+    /** Shot ids that keep their pace (a logo hold, a line of narration); the others absorb the change. */
+    keep?: readonly string[];
+}
+interface MotionFit {
+    scene: MotionScene;
+    /** The length after fitting, ms (within a few ms of the target: speeds are rounded). */
+    duration: number;
+    /** The new `speed` of every shot that changed. */
+    speeds: Record<string, number>;
+}
+/** Speeds are kept within this range. */
+declare const MOTION_SPEED_RANGE: readonly [number, number];
+/**
+ * Fits a scene to `ms` by setting its shots' `speed`: the shots in `keep` play as they are and
+ * the rest stretch or squeeze by the same factor, so their timing keeps its proportions (the
+ * responsive time of After Effects' protected regions). Throws, changing nothing, when the
+ * kept shots alone outlast the target or a speed would leave `MOTION_SPEED_RANGE`.
+ */
+declare function fitMotionScene(scene: MotionScene, ms: number, options?: MotionFitOptions): MotionFit;
+
 /**
  * Export to Flair (`@pixerate/flair`): a scene becomes an `SvgMotion` (one SVG plus a list of
  * from → to changes on its elements), a catalog `VectorEffect`, or an `EffectDocument` for
@@ -1655,6 +1742,8 @@ declare function describeMotionShots(scene: MotionScene): {
         note?: string;
         index: number;
     })[];
+    missedBy?: number | undefined;
+    cue?: number | undefined;
     hold?: number | undefined;
     camera?: MotionCamera | undefined;
     start: number;
@@ -1675,6 +1764,6 @@ declare function createAnimationEditorToolProvider(controller: AnimationEditorCo
  * A short authoring guide for a model writing vector animations with the animation editor's
  * tools. Static, so it caches well as part of a system prompt.
  */
-declare const ANIMATION_EDITOR_AGENT_INSTRUCTIONS = "You animate vector artwork. A scene is artwork (vector paths and groups, each with an id) plus shots.\n\nHow it plays\n- Shots play in order. A shot optionally moves the camera, plays its commands, then holds (default 600 ms).\n- Commands in a shot play one after another; give \"with\": \"previous\" to start one together with the command before, \"delay\" to wait, \"stagger\" to offset several targets.\n- Timing comes from the content: each command has a default length (enter 600 ms, move 700 ms, draw follows the path length). Only set \"duration\" to change the pace.\n- Anything that enters later is hidden until it enters. Things that never enter are visible from the start.\n- Every frame is a pure function of time: the same scene always plays the same frames.\n\nCommands\n- enter (fade, pop, grow, slide, draw) and exit (fade, shrink, slide, undraw) bring things in and out.\n- enter also reveals through a clip over the target's box: wipe (behind an edge travelling \"direction\", default right), iris (from the centre; \"shape\": circle or box) and split (from a line through the middle; \"orientation\": horizontal or vertical). exit wipe hides the same way. Reveals need a width and a height: use draw / undraw for a straight line.\n- draw draws strokes on to a fraction; move, rotate, scale and fade change the pose (about the centre); style blends solid colours and stroke width.\n- enter also has zoom (settles from larger) and rise (rises a short way, overshooting a touch); pop and zoom take a starting \"scale\".\n- morph turns a shape into another node's shape (keep the target hidden); match does the same for a whole group, part by part (Smart Animate: draw the end state as a second, hidden group whose parts share names with the first); follow moves along a path node (with \"rotate\", moves made meanwhile turn with the path).\n- Emphasis draws the eye and returns to rest: pulse (swell), shake (side to side, or \"axis\": \"vertical\"), teeter (rock), wave (bob, no settling), wiggle (seeded wander; the same seed wanders the same way) and color-pulse (tint and back).\n- Emphasis stacks on other motion: a shake during a slide shakes as it slides. Give move, rotate or scale \"blend\": \"add\" to stack them too (what they add stays); \"blend\": \"replace\" makes a change take over instead.\n- Any command but enter and exit can \"repeat\" (loop, mirror back and forth, or offset to carry on: rotate by 90, repeat 4 is a full turn); \"duration\" is one cycle.\n- Springs (\"spring-gentle\", \"spring-quick\", \"spring-bouncy\", \"spring-slow\" or { \"type\": \"spring\", \u2026 }) feel physical; leave \"duration\" out and the spring sets it.\n- \"steps\": 12 (on a command, or for the whole scene with set_animation_settings) holds poses \"on twos\" for a hand-drawn look. \"geometric\": true on scale or a camera zooms at an even rate.\n- Commands share their names and defaults with Flair's motion primitives (get_animation shows each one's \"flairPrimitive\"), and emphasis, reveals and follows export to Flair exactly.\n- effect tweens a numeric parameter of a live path effect already on the node (twist angle, wiggle time, zig zag size).\n\nWorking method\n1. get_animation to learn the element ids (set_animation_artwork_svg first if there is no artwork: give every element you will animate an id; or import_flair_effect to start from a Flair effect and edit it).\n2. Plan a few shots, each one idea. Add them with insert_shots, or edit_animation to make several edits as one step (dry_run first when unsure).\n3. check_animation and fix every error and warning; render_animation_frame (shot + \"end\") to look at the result.\n4. To make a reusable Flair effect, set_animation_controls (colour controls stand for every use of their default colour) and export_flair_effect.\n\nKeep motion purposeful: one thing moving at a time reads best, ease-out for arrivals, ease-in for exits, and hold long enough to see each result.";
+declare const ANIMATION_EDITOR_AGENT_INSTRUCTIONS = "You animate vector artwork. A scene is artwork (vector paths and groups, each with an id) plus shots.\n\nHow it plays\n- Shots play in order. A shot optionally moves the camera, plays its commands, then holds (default 600 ms).\n- Commands in a shot play one after another; give \"with\": \"previous\" to start one together with the command before, \"delay\" to wait, \"stagger\" to offset several targets.\n- Timing comes from the content: each command has a default length (enter 600 ms, move 700 ms, draw follows the path length). Only set \"duration\" to change the pace.\n- Anything that enters later is hidden until it enters. Things that never enter are visible from the start.\n- Every frame is a pure function of time: the same scene always plays the same frames.\n\nCommands\n- enter (fade, pop, grow, slide, draw) and exit (fade, shrink, slide, undraw) bring things in and out.\n- enter also reveals through a clip over the target's box: wipe (behind an edge travelling \"direction\", default right), iris (from the centre; \"shape\": circle or box) and split (from a line through the middle; \"orientation\": horizontal or vertical). exit wipe hides the same way. Reveals need a width and a height: use draw / undraw for a straight line.\n- draw draws strokes on to a fraction; move, rotate, scale and fade change the pose (about the centre); style blends solid colours and stroke width.\n- enter also has zoom (settles from larger) and rise (rises a short way, overshooting a touch); pop and zoom take a starting \"scale\".\n- morph turns a shape into another node's shape (keep the target hidden); match does the same for a whole group, part by part (Smart Animate: draw the end state as a second, hidden group whose parts share names with the first); follow moves along a path node (with \"rotate\", moves made meanwhile turn with the path).\n- Emphasis draws the eye and returns to rest: pulse (swell), shake (side to side, or \"axis\": \"vertical\"), teeter (rock), wave (bob, no settling), wiggle (seeded wander; the same seed wanders the same way) and color-pulse (tint and back).\n- Emphasis stacks on other motion: a shake during a slide shakes as it slides. Give move, rotate or scale \"blend\": \"add\" to stack them too (what they add stays); \"blend\": \"replace\" makes a change take over instead.\n- Any command but enter and exit can \"repeat\" (loop, mirror back and forth, or offset to carry on: rotate by 90, repeat 4 is a full turn); \"duration\" is one cycle.\n- Springs (\"spring-gentle\", \"spring-quick\", \"spring-bouncy\", \"spring-slow\" or { \"type\": \"spring\", \u2026 }) feel physical; leave \"duration\" out and the spring sets it.\n- To time shots to music or a voiceover: set a \"beat\" grid or \"narration\" word timings with set_animation_settings, read them with get_timing_grid, and give a shot \"at\": { \"beat\": n } or { \"word\": i }. The shot before holds until the cue; check_animation warns when a cue is missed.\n- \"steps\": 12 (on a command, or for the whole scene with set_animation_settings) holds poses \"on twos\" for a hand-drawn look. \"geometric\": true on scale or a camera zooms at an even rate.\n- Commands share their names and defaults with Flair's motion primitives (get_animation shows each one's \"flairPrimitive\"), and emphasis, reveals and follows export to Flair exactly.\n- effect tweens a numeric parameter of a live path effect already on the node (twist angle, wiggle time, zig zag size).\n\nWorking method\n1. get_animation to learn the element ids (set_animation_artwork_svg first if there is no artwork: give every element you will animate an id; or import_flair_effect to start from a Flair effect and edit it).\n2. Plan a few shots, each one idea. Add them with insert_shots, or edit_animation to make several edits as one step (dry_run first when unsure).\n3. To hit a length, fit_animation (keep the shots whose pace matters). check_animation and fix every error and warning; render_animation_frame (shot + \"end\") to look at the result.\n4. To make a reusable Flair effect, set_animation_controls (colour controls stand for every use of their default colour) and export_flair_effect.\n\nKeep motion purposeful: one thing moving at a time reads best, ease-out for arrivals, ease-in for exits, and hold long enough to see each result.";
 
-export { ANIMATION_EDITOR_AGENT_INSTRUCTIONS, AnimationEditorController, type AnimationEditorOptions, type AnimationEditorSelection, type AnimationEditorState, type AnimationEditorToolProviderOptions, FLAIR_EASES, FLAIR_EXPORT_VERSION, type FlairEase, type FlairEaseName, type FlairEffectDocument, type FlairEffectOptions, type FlairExportOptions, type FlairImportOptions, type FlairImportResult, type FlairMotionExport, type FlairSpringEase, type FlairSvgAnimation, type FlairSvgMotion, type FlairVectorEffect, MOTION_ADDITIVE_PROPERTIES, MOTION_BLENDS, MOTION_CAMERA_MS, MOTION_COMMAND_SCHEMA, MOTION_COMMAND_TYPES, MOTION_DEFAULT_DURATIONS, MOTION_DEFAULT_HOLD, MOTION_DIRECTIONS, MOTION_DRAW_EFFECT_ID, MOTION_DRAW_MS_PER_UNIT, MOTION_DRAW_RANGE, MOTION_EASE_IN_OUT, MOTION_EASE_OUT, MOTION_EDIT_OPS, MOTION_ENTER_STYLES, MOTION_EXIT_STYLES, MOTION_IRIS_SHAPES, MOTION_ISSUE_CODES, MOTION_MIN_CHANGE_MS, MOTION_REPEAT_MODES, MOTION_SPLIT_ORIENTATIONS, type MotionCamera, type MotionClipShape, type MotionColorPulseCommand, type MotionCommand, type MotionCommandBase, type MotionCommandTiming, type MotionCommandType, type MotionControl, type MotionDirection, type MotionDrawCommand, type MotionEdit, type MotionEditOp, type MotionEditResult, type MotionEffectCommand, type MotionEnterCommand, type MotionEnterStyle, type MotionExitCommand, type MotionExitStyle, type MotionFadeCommand, type MotionFollowCommand, type MotionFrame, type MotionFrameOptions, type MotionIrisShape, type MotionIssue, type MotionIssueCode, type MotionIssueSeverity, type MotionMatch, type MotionMatchCommand, type MotionMorphCommand, type MotionMoveCommand, type MotionNodeEntry, type MotionPreset, type MotionProperty, type MotionPulseCommand, type MotionRect, type MotionReveal, type MotionRotateCommand, type MotionScaleCommand, type MotionScene, MotionSceneFormatError, type MotionSegment, type MotionShakeCommand, type MotionShot, type MotionShotTiming, type MotionSplitOrientation, type MotionStyleCommand, type MotionSvgOptions, type MotionTeeterCommand, type MotionTimeline, type MotionValue, type MotionWaitCommand, type MotionWaveCommand, type MotionWiggleCommand, activeSegment, applyMotionControlValues, applyMotionEdits, checkMotionScene, commandShapeProblems, compileMotionScene, createAnimationEditorToolProvider, createMotionScene, describeMotionElements, describeMotionShots, fitMotionRect, flairAtLeast, flairCurveFor, flairEaseFor, freshShotId, fromFlairSvgMotion, fromFlairVectorEffect, indexMotionNodes, interpolateMotionValue, isMotionCommand, isMotionShot, matchMotionNodes, motionAddTrackKey, motionClipAttrs, motionCommandDuration, motionCommandRepeat, motionCycleDuration, motionFlairPrimitive, motionFollowRoute, motionFrameAt, motionFrameToSvg, motionIssue, motionIssueKey, motionIssueLine, motionNodeClips, motionNodeOffset, motionPathLength, motionRestValue, motionRevealClip, motionRevealPadding, motionSceneShapeProblems, motionSceneToJson, motionShotAt, motionTrackKey, namedWithSuggestion, parseMotionScene, resolveMotionCamera, segmentProgress, segmentValue, shotShapeProblems, suggestName, toFlairEffectDocument, toFlairSvgMotion, toFlairVectorEffect, trackValue, withMotionLayers, withViewBox };
+export { ANIMATION_EDITOR_AGENT_INSTRUCTIONS, AnimationEditorController, type AnimationEditorOptions, type AnimationEditorSelection, type AnimationEditorState, type AnimationEditorToolProviderOptions, FLAIR_EASES, FLAIR_EXPORT_VERSION, type FlairEase, type FlairEaseName, type FlairEffectDocument, type FlairEffectOptions, type FlairExportOptions, type FlairImportOptions, type FlairImportResult, type FlairMotionExport, type FlairSpringEase, type FlairSvgAnimation, type FlairSvgMotion, type FlairVectorEffect, MOTION_ADDITIVE_PROPERTIES, MOTION_BLENDS, MOTION_CAMERA_MS, MOTION_COMMAND_SCHEMA, MOTION_COMMAND_TYPES, MOTION_DEFAULT_DURATIONS, MOTION_DEFAULT_HOLD, MOTION_DIRECTIONS, MOTION_DRAW_EFFECT_ID, MOTION_DRAW_MS_PER_UNIT, MOTION_DRAW_RANGE, MOTION_EASE_IN_OUT, MOTION_EASE_OUT, MOTION_EDIT_OPS, MOTION_ENTER_STYLES, MOTION_EXIT_STYLES, MOTION_IRIS_SHAPES, MOTION_ISSUE_CODES, MOTION_MIN_CHANGE_MS, MOTION_REPEAT_MODES, MOTION_SPEED_RANGE, MOTION_SPLIT_ORIENTATIONS, type MotionBeatGrid, type MotionCamera, type MotionClipShape, type MotionColorPulseCommand, type MotionCommand, type MotionCommandBase, type MotionCommandTiming, type MotionCommandType, type MotionControl, type MotionCue, type MotionDirection, type MotionDrawCommand, type MotionEdit, type MotionEditOp, type MotionEditResult, type MotionEffectCommand, type MotionEnterCommand, type MotionEnterStyle, type MotionExitCommand, type MotionExitStyle, type MotionFadeCommand, type MotionFit, type MotionFitOptions, type MotionFollowCommand, type MotionFrame, type MotionFrameOptions, type MotionIrisShape, type MotionIssue, type MotionIssueCode, type MotionIssueSeverity, type MotionMatch, type MotionMatchCommand, type MotionMorphCommand, type MotionMoveCommand, type MotionNarration, type MotionNodeEntry, type MotionPreset, type MotionProperty, type MotionPulseCommand, type MotionRect, type MotionReveal, type MotionRotateCommand, type MotionScaleCommand, type MotionScene, MotionSceneFormatError, type MotionSegment, type MotionShakeCommand, type MotionShot, type MotionShotTiming, type MotionSplitOrientation, type MotionStyleCommand, type MotionSvgOptions, type MotionTeeterCommand, type MotionTimeline, type MotionValue, type MotionWaitCommand, type MotionWaveCommand, type MotionWiggleCommand, activeSegment, applyMotionControlValues, applyMotionEdits, checkMotionScene, commandShapeProblems, compileMotionScene, createAnimationEditorToolProvider, createMotionScene, describeMotionElements, describeMotionShots, fitMotionRect, fitMotionScene, flairAtLeast, flairCurveFor, flairEaseFor, freshShotId, fromFlairSvgMotion, fromFlairVectorEffect, indexMotionNodes, interpolateMotionValue, isMotionCommand, isMotionShot, matchMotionNodes, motionAddTrackKey, motionBeatAt, motionBeatTime, motionClipAttrs, motionCommandDuration, motionCommandRepeat, motionCueTime, motionCycleDuration, motionFlairPrimitive, motionFollowRoute, motionFrameAt, motionFrameToSvg, motionIssue, motionIssueKey, motionIssueLine, motionNodeClips, motionNodeOffset, motionPathLength, motionRestValue, motionRevealClip, motionRevealPadding, motionSceneShapeProblems, motionSceneToJson, motionShotAt, motionShotTimeScale, motionTrackKey, namedWithSuggestion, parseMotionScene, resolveMotionCamera, segmentProgress, segmentValue, shotShapeProblems, suggestName, toFlairEffectDocument, toFlairSvgMotion, toFlairVectorEffect, trackValue, withMotionLayers, withViewBox };

package/dist/animation-editor/index.d.ts

@@ -36,6 +36,10 @@ interface MotionScene {
      * per second ("on twos" at 12), for a hand-drawn look. Default: smooth.
      */
     steps?: number;
+    /** A beat grid to cue shots to (`MotionShot.at.beat`): music or a voiceover's rhythm. */
+    beat?: MotionBeatGrid;
+    /** A voiceover's words with their times, to cue shots to (`MotionShot.at.word`). */
+    narration?: MotionNarration;
     /** Wanted length in seconds `[min, max]`; `check` warns outside it. */
     target?: [number, number];
     /** Parameters a Flair effect made from this scene exposes (see `toFlairVectorEffect`). */
@@ -63,6 +67,31 @@ type MotionCamera = (MotionRect | {
     /** Zoom at a steady rate (the size changes by the same factor each moment) instead of linearly. */
     geometric?: boolean;
 };
+/** A steady beat: `bpm` beats a minute, the first at `offset` ms, `meter` beats a bar. */
+interface MotionBeatGrid {
+    bpm: number;
+    /** When beat 0 falls, ms (default 0). */
+    offset?: number;
+    /** Beats in a bar (default 4), for reading beats as bar and beat. */
+    meter?: number;
+}
+/** A voiceover: its words in order, each with when it is said (ms), from a TTS or speech-to-text word timing. */
+interface MotionNarration {
+    words: {
+        text: string;
+        start: number;
+        end?: number;
+    }[];
+}
+/** When a shot is cued to start: on a beat, on a narration word, or at a time. */
+interface MotionCue {
+    /** Beat number on the scene's beat grid, from 0 (fractions for off-beats: 2.5 is the "and" of beat 3). */
+    beat?: number;
+    /** Index of a word in the scene's narration, from 0. */
+    word?: number;
+    /** A time in ms. */
+    ms?: number;
+}
 /** One beat of the animation. */
 interface MotionShot {
     /** Stable id (unique in the scene), e.g. `intro`. */
@@ -71,10 +100,21 @@ interface MotionShot {
     label?: string;
     /** Omit to keep the current framing. */
     camera?: MotionCamera;
+    /**
+     * Start on a cue: a beat, a narration word or a time. The shot before holds until then; a
+     * cue that comes before the shot before has ended is missed (`check` says by how much).
+     * Give one of `beat`, `word` or `ms`.
+     */
+    at?: MotionCue;
     /** Commands, played one after another (unless a command says `with: "previous"`). */
     run: MotionCommand[];
     /** Milliseconds to hold after the commands finish (default 600). */
     hold?: number;
+    /**
+     * Plays the whole shot this many times as fast (default 1): its camera move, delays,
+     * durations, staggers and hold all scale by 1 / speed. `fit_animation` sets it to fit a length.
+     */
+    speed?: number;
 }
 /** Fields every command takes. */
 interface MotionCommandBase {
@@ -492,6 +532,14 @@ declare const MOTION_ISSUE_CODES: {
         readonly severity: "warning";
         readonly wording: "A spring is given a duration shorter than it takes to settle, so it jumps to its end.";
     };
+    readonly 'unknown-cue': {
+        readonly severity: "error";
+        readonly wording: "A shot is cued to a beat with no beat grid, or to a word the narration does not have.";
+    };
+    readonly 'cue-missed': {
+        readonly severity: "warning";
+        readonly wording: "A shot starts after its cue, because the shot before runs past it.";
+    };
     readonly 'scene-too-long': {
         readonly severity: "warning";
         readonly wording: "The scene runs past its target length.";
@@ -626,6 +674,10 @@ interface MotionShotTiming {
     /** When the last command ends (the hold follows). */
     commandsEnd: number;
     end: number;
+    /** The time the shot is cued to start (`at`), when it has a cue that resolves. */
+    cue?: number;
+    /** How late the shot starts after its cue (ms), when the shot before ran past it. */
+    missedBy?: number;
 }
 interface MotionCommandTiming {
     shot: string;
@@ -730,6 +782,18 @@ declare function fitMotionRect(rect: MotionRect, aspect: number): MotionRect;
 declare function resolveMotionCamera(camera: MotionCamera, scene: MotionScene): MotionRect | null;
 /** Length of a node's outline (its longest path for a group), in document units. */
 declare function motionPathLength(node: VectorNode, parentWorld?: AffineMatrix): number;
+/** How much a shot's `speed` stretches its time (1 / speed; 1 when unset or not above 0). */
+declare function motionShotTimeScale(shot: MotionShot): number;
+/** When beat `beat` falls on a grid, ms: `offset + beat · 60000 / bpm`. */
+declare function motionBeatTime(grid: MotionBeatGrid, beat: number): number;
+/** The beat (fractional) at `ms` on a grid, and its bar and beat in the bar (both from 1). */
+declare function motionBeatAt(grid: MotionBeatGrid, ms: number): {
+    beat: number;
+    bar: number;
+    beatInBar: number;
+};
+/** The time a cue names, ms, or undefined when it names a beat with no grid or a word the narration lacks. */
+declare function motionCueTime(scene: Pick<MotionScene, 'beat' | 'narration'>, cue: MotionCue): number | undefined;
 /** How many times a command plays (1 for `enter`, `exit` and `wait`, which do not repeat). */
 declare function motionCommandRepeat(command: MotionCommand): number;
 /** How long one target of a command takes (ms), every repeat included. */
@@ -868,6 +932,8 @@ type MotionEdit = {
     loop?: MotionScene['loop'];
     fps?: number;
     steps?: number | null;
+    beat?: MotionScene['beat'] | null;
+    narration?: MotionScene['narration'] | null;
     target?: [number, number] | null;
 } | {
     op: 'insert_shots';
@@ -877,7 +943,7 @@ type MotionEdit = {
     op: 'update_shot';
     shot: string;
     set?: Partial<MotionShot>;
-    remove?: ('label' | 'camera' | 'hold')[];
+    remove?: ('label' | 'camera' | 'hold' | 'speed' | 'at')[];
 } | {
     op: 'delete_shots';
     shots: string[];
@@ -931,6 +997,27 @@ declare function applyMotionEdits(scene: MotionScene, edits: MotionEdit | readon
 /** An empty scene over `artwork`. */
 declare function createMotionScene(artwork: VectorDocument, init?: Partial<Omit<MotionScene, 'artwork' | 'version'>>): MotionScene;
 
+interface MotionFitOptions {
+    /** Shot ids that keep their pace (a logo hold, a line of narration); the others absorb the change. */
+    keep?: readonly string[];
+}
+interface MotionFit {
+    scene: MotionScene;
+    /** The length after fitting, ms (within a few ms of the target: speeds are rounded). */
+    duration: number;
+    /** The new `speed` of every shot that changed. */
+    speeds: Record<string, number>;
+}
+/** Speeds are kept within this range. */
+declare const MOTION_SPEED_RANGE: readonly [number, number];
+/**
+ * Fits a scene to `ms` by setting its shots' `speed`: the shots in `keep` play as they are and
+ * the rest stretch or squeeze by the same factor, so their timing keeps its proportions (the
+ * responsive time of After Effects' protected regions). Throws, changing nothing, when the
+ * kept shots alone outlast the target or a speed would leave `MOTION_SPEED_RANGE`.
+ */
+declare function fitMotionScene(scene: MotionScene, ms: number, options?: MotionFitOptions): MotionFit;
+
 /**
  * Export to Flair (`@pixerate/flair`): a scene becomes an `SvgMotion` (one SVG plus a list of
  * from → to changes on its elements), a catalog `VectorEffect`, or an `EffectDocument` for
@@ -1655,6 +1742,8 @@ declare function describeMotionShots(scene: MotionScene): {
         note?: string;
         index: number;
     })[];
+    missedBy?: number | undefined;
+    cue?: number | undefined;
     hold?: number | undefined;
     camera?: MotionCamera | undefined;
     start: number;
@@ -1675,6 +1764,6 @@ declare function createAnimationEditorToolProvider(controller: AnimationEditorCo
  * A short authoring guide for a model writing vector animations with the animation editor's
  * tools. Static, so it caches well as part of a system prompt.
  */
-declare const ANIMATION_EDITOR_AGENT_INSTRUCTIONS = "You animate vector artwork. A scene is artwork (vector paths and groups, each with an id) plus shots.\n\nHow it plays\n- Shots play in order. A shot optionally moves the camera, plays its commands, then holds (default 600 ms).\n- Commands in a shot play one after another; give \"with\": \"previous\" to start one together with the command before, \"delay\" to wait, \"stagger\" to offset several targets.\n- Timing comes from the content: each command has a default length (enter 600 ms, move 700 ms, draw follows the path length). Only set \"duration\" to change the pace.\n- Anything that enters later is hidden until it enters. Things that never enter are visible from the start.\n- Every frame is a pure function of time: the same scene always plays the same frames.\n\nCommands\n- enter (fade, pop, grow, slide, draw) and exit (fade, shrink, slide, undraw) bring things in and out.\n- enter also reveals through a clip over the target's box: wipe (behind an edge travelling \"direction\", default right), iris (from the centre; \"shape\": circle or box) and split (from a line through the middle; \"orientation\": horizontal or vertical). exit wipe hides the same way. Reveals need a width and a height: use draw / undraw for a straight line.\n- draw draws strokes on to a fraction; move, rotate, scale and fade change the pose (about the centre); style blends solid colours and stroke width.\n- enter also has zoom (settles from larger) and rise (rises a short way, overshooting a touch); pop and zoom take a starting \"scale\".\n- morph turns a shape into another node's shape (keep the target hidden); match does the same for a whole group, part by part (Smart Animate: draw the end state as a second, hidden group whose parts share names with the first); follow moves along a path node (with \"rotate\", moves made meanwhile turn with the path).\n- Emphasis draws the eye and returns to rest: pulse (swell), shake (side to side, or \"axis\": \"vertical\"), teeter (rock), wave (bob, no settling), wiggle (seeded wander; the same seed wanders the same way) and color-pulse (tint and back).\n- Emphasis stacks on other motion: a shake during a slide shakes as it slides. Give move, rotate or scale \"blend\": \"add\" to stack them too (what they add stays); \"blend\": \"replace\" makes a change take over instead.\n- Any command but enter and exit can \"repeat\" (loop, mirror back and forth, or offset to carry on: rotate by 90, repeat 4 is a full turn); \"duration\" is one cycle.\n- Springs (\"spring-gentle\", \"spring-quick\", \"spring-bouncy\", \"spring-slow\" or { \"type\": \"spring\", \u2026 }) feel physical; leave \"duration\" out and the spring sets it.\n- \"steps\": 12 (on a command, or for the whole scene with set_animation_settings) holds poses \"on twos\" for a hand-drawn look. \"geometric\": true on scale or a camera zooms at an even rate.\n- Commands share their names and defaults with Flair's motion primitives (get_animation shows each one's \"flairPrimitive\"), and emphasis, reveals and follows export to Flair exactly.\n- effect tweens a numeric parameter of a live path effect already on the node (twist angle, wiggle time, zig zag size).\n\nWorking method\n1. get_animation to learn the element ids (set_animation_artwork_svg first if there is no artwork: give every element you will animate an id; or import_flair_effect to start from a Flair effect and edit it).\n2. Plan a few shots, each one idea. Add them with insert_shots, or edit_animation to make several edits as one step (dry_run first when unsure).\n3. check_animation and fix every error and warning; render_animation_frame (shot + \"end\") to look at the result.\n4. To make a reusable Flair effect, set_animation_controls (colour controls stand for every use of their default colour) and export_flair_effect.\n\nKeep motion purposeful: one thing moving at a time reads best, ease-out for arrivals, ease-in for exits, and hold long enough to see each result.";
+declare const ANIMATION_EDITOR_AGENT_INSTRUCTIONS = "You animate vector artwork. A scene is artwork (vector paths and groups, each with an id) plus shots.\n\nHow it plays\n- Shots play in order. A shot optionally moves the camera, plays its commands, then holds (default 600 ms).\n- Commands in a shot play one after another; give \"with\": \"previous\" to start one together with the command before, \"delay\" to wait, \"stagger\" to offset several targets.\n- Timing comes from the content: each command has a default length (enter 600 ms, move 700 ms, draw follows the path length). Only set \"duration\" to change the pace.\n- Anything that enters later is hidden until it enters. Things that never enter are visible from the start.\n- Every frame is a pure function of time: the same scene always plays the same frames.\n\nCommands\n- enter (fade, pop, grow, slide, draw) and exit (fade, shrink, slide, undraw) bring things in and out.\n- enter also reveals through a clip over the target's box: wipe (behind an edge travelling \"direction\", default right), iris (from the centre; \"shape\": circle or box) and split (from a line through the middle; \"orientation\": horizontal or vertical). exit wipe hides the same way. Reveals need a width and a height: use draw / undraw for a straight line.\n- draw draws strokes on to a fraction; move, rotate, scale and fade change the pose (about the centre); style blends solid colours and stroke width.\n- enter also has zoom (settles from larger) and rise (rises a short way, overshooting a touch); pop and zoom take a starting \"scale\".\n- morph turns a shape into another node's shape (keep the target hidden); match does the same for a whole group, part by part (Smart Animate: draw the end state as a second, hidden group whose parts share names with the first); follow moves along a path node (with \"rotate\", moves made meanwhile turn with the path).\n- Emphasis draws the eye and returns to rest: pulse (swell), shake (side to side, or \"axis\": \"vertical\"), teeter (rock), wave (bob, no settling), wiggle (seeded wander; the same seed wanders the same way) and color-pulse (tint and back).\n- Emphasis stacks on other motion: a shake during a slide shakes as it slides. Give move, rotate or scale \"blend\": \"add\" to stack them too (what they add stays); \"blend\": \"replace\" makes a change take over instead.\n- Any command but enter and exit can \"repeat\" (loop, mirror back and forth, or offset to carry on: rotate by 90, repeat 4 is a full turn); \"duration\" is one cycle.\n- Springs (\"spring-gentle\", \"spring-quick\", \"spring-bouncy\", \"spring-slow\" or { \"type\": \"spring\", \u2026 }) feel physical; leave \"duration\" out and the spring sets it.\n- To time shots to music or a voiceover: set a \"beat\" grid or \"narration\" word timings with set_animation_settings, read them with get_timing_grid, and give a shot \"at\": { \"beat\": n } or { \"word\": i }. The shot before holds until the cue; check_animation warns when a cue is missed.\n- \"steps\": 12 (on a command, or for the whole scene with set_animation_settings) holds poses \"on twos\" for a hand-drawn look. \"geometric\": true on scale or a camera zooms at an even rate.\n- Commands share their names and defaults with Flair's motion primitives (get_animation shows each one's \"flairPrimitive\"), and emphasis, reveals and follows export to Flair exactly.\n- effect tweens a numeric parameter of a live path effect already on the node (twist angle, wiggle time, zig zag size).\n\nWorking method\n1. get_animation to learn the element ids (set_animation_artwork_svg first if there is no artwork: give every element you will animate an id; or import_flair_effect to start from a Flair effect and edit it).\n2. Plan a few shots, each one idea. Add them with insert_shots, or edit_animation to make several edits as one step (dry_run first when unsure).\n3. To hit a length, fit_animation (keep the shots whose pace matters). check_animation and fix every error and warning; render_animation_frame (shot + \"end\") to look at the result.\n4. To make a reusable Flair effect, set_animation_controls (colour controls stand for every use of their default colour) and export_flair_effect.\n\nKeep motion purposeful: one thing moving at a time reads best, ease-out for arrivals, ease-in for exits, and hold long enough to see each result.";
 
-export { ANIMATION_EDITOR_AGENT_INSTRUCTIONS, AnimationEditorController, type AnimationEditorOptions, type AnimationEditorSelection, type AnimationEditorState, type AnimationEditorToolProviderOptions, FLAIR_EASES, FLAIR_EXPORT_VERSION, type FlairEase, type FlairEaseName, type FlairEffectDocument, type FlairEffectOptions, type FlairExportOptions, type FlairImportOptions, type FlairImportResult, type FlairMotionExport, type FlairSpringEase, type FlairSvgAnimation, type FlairSvgMotion, type FlairVectorEffect, MOTION_ADDITIVE_PROPERTIES, MOTION_BLENDS, MOTION_CAMERA_MS, MOTION_COMMAND_SCHEMA, MOTION_COMMAND_TYPES, MOTION_DEFAULT_DURATIONS, MOTION_DEFAULT_HOLD, MOTION_DIRECTIONS, MOTION_DRAW_EFFECT_ID, MOTION_DRAW_MS_PER_UNIT, MOTION_DRAW_RANGE, MOTION_EASE_IN_OUT, MOTION_EASE_OUT, MOTION_EDIT_OPS, MOTION_ENTER_STYLES, MOTION_EXIT_STYLES, MOTION_IRIS_SHAPES, MOTION_ISSUE_CODES, MOTION_MIN_CHANGE_MS, MOTION_REPEAT_MODES, MOTION_SPLIT_ORIENTATIONS, type MotionCamera, type MotionClipShape, type MotionColorPulseCommand, type MotionCommand, type MotionCommandBase, type MotionCommandTiming, type MotionCommandType, type MotionControl, type MotionDirection, type MotionDrawCommand, type MotionEdit, type MotionEditOp, type MotionEditResult, type MotionEffectCommand, type MotionEnterCommand, type MotionEnterStyle, type MotionExitCommand, type MotionExitStyle, type MotionFadeCommand, type MotionFollowCommand, type MotionFrame, type MotionFrameOptions, type MotionIrisShape, type MotionIssue, type MotionIssueCode, type MotionIssueSeverity, type MotionMatch, type MotionMatchCommand, type MotionMorphCommand, type MotionMoveCommand, type MotionNodeEntry, type MotionPreset, type MotionProperty, type MotionPulseCommand, type MotionRect, type MotionReveal, type MotionRotateCommand, type MotionScaleCommand, type MotionScene, MotionSceneFormatError, type MotionSegment, type MotionShakeCommand, type MotionShot, type MotionShotTiming, type MotionSplitOrientation, type MotionStyleCommand, type MotionSvgOptions, type MotionTeeterCommand, type MotionTimeline, type MotionValue, type MotionWaitCommand, type MotionWaveCommand, type MotionWiggleCommand, activeSegment, applyMotionControlValues, applyMotionEdits, checkMotionScene, commandShapeProblems, compileMotionScene, createAnimationEditorToolProvider, createMotionScene, describeMotionElements, describeMotionShots, fitMotionRect, flairAtLeast, flairCurveFor, flairEaseFor, freshShotId, fromFlairSvgMotion, fromFlairVectorEffect, indexMotionNodes, interpolateMotionValue, isMotionCommand, isMotionShot, matchMotionNodes, motionAddTrackKey, motionClipAttrs, motionCommandDuration, motionCommandRepeat, motionCycleDuration, motionFlairPrimitive, motionFollowRoute, motionFrameAt, motionFrameToSvg, motionIssue, motionIssueKey, motionIssueLine, motionNodeClips, motionNodeOffset, motionPathLength, motionRestValue, motionRevealClip, motionRevealPadding, motionSceneShapeProblems, motionSceneToJson, motionShotAt, motionTrackKey, namedWithSuggestion, parseMotionScene, resolveMotionCamera, segmentProgress, segmentValue, shotShapeProblems, suggestName, toFlairEffectDocument, toFlairSvgMotion, toFlairVectorEffect, trackValue, withMotionLayers, withViewBox };
+export { ANIMATION_EDITOR_AGENT_INSTRUCTIONS, AnimationEditorController, type AnimationEditorOptions, type AnimationEditorSelection, type AnimationEditorState, type AnimationEditorToolProviderOptions, FLAIR_EASES, FLAIR_EXPORT_VERSION, type FlairEase, type FlairEaseName, type FlairEffectDocument, type FlairEffectOptions, type FlairExportOptions, type FlairImportOptions, type FlairImportResult, type FlairMotionExport, type FlairSpringEase, type FlairSvgAnimation, type FlairSvgMotion, type FlairVectorEffect, MOTION_ADDITIVE_PROPERTIES, MOTION_BLENDS, MOTION_CAMERA_MS, MOTION_COMMAND_SCHEMA, MOTION_COMMAND_TYPES, MOTION_DEFAULT_DURATIONS, MOTION_DEFAULT_HOLD, MOTION_DIRECTIONS, MOTION_DRAW_EFFECT_ID, MOTION_DRAW_MS_PER_UNIT, MOTION_DRAW_RANGE, MOTION_EASE_IN_OUT, MOTION_EASE_OUT, MOTION_EDIT_OPS, MOTION_ENTER_STYLES, MOTION_EXIT_STYLES, MOTION_IRIS_SHAPES, MOTION_ISSUE_CODES, MOTION_MIN_CHANGE_MS, MOTION_REPEAT_MODES, MOTION_SPEED_RANGE, MOTION_SPLIT_ORIENTATIONS, type MotionBeatGrid, type MotionCamera, type MotionClipShape, type MotionColorPulseCommand, type MotionCommand, type MotionCommandBase, type MotionCommandTiming, type MotionCommandType, type MotionControl, type MotionCue, type MotionDirection, type MotionDrawCommand, type MotionEdit, type MotionEditOp, type MotionEditResult, type MotionEffectCommand, type MotionEnterCommand, type MotionEnterStyle, type MotionExitCommand, type MotionExitStyle, type MotionFadeCommand, type MotionFit, type MotionFitOptions, type MotionFollowCommand, type MotionFrame, type MotionFrameOptions, type MotionIrisShape, type MotionIssue, type MotionIssueCode, type MotionIssueSeverity, type MotionMatch, type MotionMatchCommand, type MotionMorphCommand, type MotionMoveCommand, type MotionNarration, type MotionNodeEntry, type MotionPreset, type MotionProperty, type MotionPulseCommand, type MotionRect, type MotionReveal, type MotionRotateCommand, type MotionScaleCommand, type MotionScene, MotionSceneFormatError, type MotionSegment, type MotionShakeCommand, type MotionShot, type MotionShotTiming, type MotionSplitOrientation, type MotionStyleCommand, type MotionSvgOptions, type MotionTeeterCommand, type MotionTimeline, type MotionValue, type MotionWaitCommand, type MotionWaveCommand, type MotionWiggleCommand, activeSegment, applyMotionControlValues, applyMotionEdits, checkMotionScene, commandShapeProblems, compileMotionScene, createAnimationEditorToolProvider, createMotionScene, describeMotionElements, describeMotionShots, fitMotionRect, fitMotionScene, flairAtLeast, flairCurveFor, flairEaseFor, freshShotId, fromFlairSvgMotion, fromFlairVectorEffect, indexMotionNodes, interpolateMotionValue, isMotionCommand, isMotionShot, matchMotionNodes, motionAddTrackKey, motionBeatAt, motionBeatTime, motionClipAttrs, motionCommandDuration, motionCommandRepeat, motionCueTime, motionCycleDuration, motionFlairPrimitive, motionFollowRoute, motionFrameAt, motionFrameToSvg, motionIssue, motionIssueKey, motionIssueLine, motionNodeClips, motionNodeOffset, motionPathLength, motionRestValue, motionRevealClip, motionRevealPadding, motionSceneShapeProblems, motionSceneToJson, motionShotAt, motionShotTimeScale, motionTrackKey, namedWithSuggestion, parseMotionScene, resolveMotionCamera, segmentProgress, segmentValue, shotShapeProblems, suggestName, toFlairEffectDocument, toFlairSvgMotion, toFlairVectorEffect, trackValue, withMotionLayers, withViewBox };