@shotstack/schemas 1.5.6 → 1.5.8

package/dist/schema.d.ts

@@ -583,7 +583,7 @@ export interface components {
             alias?: string;
         };
         /** @description The type of asset to display for the duration of the Clip, i.e. a video clip or an image. Choose from one of the available asset types below. */
-        Asset: components["schemas"]["VideoAsset"] | components["schemas"]["ImageAsset"] | components["schemas"]["TextAsset"] | components["schemas"]["RichTextAsset"] | components["schemas"]["AudioAsset"] | components["schemas"]["LumaAsset"] | components["schemas"]["CaptionAsset"] | components["schemas"]["HtmlAsset"] | components["schemas"]["TitleAsset"] | components["schemas"]["ShapeAsset"] | components["schemas"]["SvgAsset"] | components["schemas"]["TextToImageAsset"] | components["schemas"]["ImageToVideoAsset"] | components["schemas"]["TextToSpeechAsset"];
+        Asset: components["schemas"]["VideoAsset"] | components["schemas"]["ImageAsset"] | components["schemas"]["TextAsset"] | components["schemas"]["RichTextAsset"] | components["schemas"]["AudioAsset"] | components["schemas"]["LumaAsset"] | components["schemas"]["CaptionAsset"] | components["schemas"]["RichCaptionAsset"] | components["schemas"]["HtmlAsset"] | components["schemas"]["TitleAsset"] | components["schemas"]["ShapeAsset"] | components["schemas"]["SvgAsset"] | components["schemas"]["TextToImageAsset"] | components["schemas"]["ImageToVideoAsset"] | components["schemas"]["TextToSpeechAsset"];
         /** @description The VideoAsset is used to create video sequences from video files. The src must be a publicly accessible URL to a video resource such as an mp4 file. */
         VideoAsset: {
             /**
@@ -968,11 +968,154 @@ export interface components {
              */
             speed?: number;
         };
+        /**
+         * @description The RichCaptionAsset provides word-level caption animations with rich-text styling. It supports
+         *     karaoke-style highlighting, word-by-word animations, and advanced typography. Use with SRT/VTT
+         *     files or auto-transcription via aliases.
+         */
+        RichCaptionAsset: {
+            /**
+             * @description The type of asset - set to `rich-caption` for rich captions. (enum property replaced by openapi-typescript)
+             * @enum {string}
+             */
+            type: "rich-caption";
+            /**
+             * @description The URL to an SRT or VTT subtitles file, or an alias reference to auto-generate captions from an audio or video clip. For file URLs, the URL must be publicly accessible or include credentials. For auto-captioning, use the format `alias://clip-name` where clip-name is the alias of an audio, video, or text-to-speech clip. Mutually exclusive with `words`.
+             * @example alias://audio
+             */
+            src?: string;
+            /** @description Pre-provided word-level timing data. Use this instead of `src` when you have word timestamps from an external source. Mutually exclusive with `src`. */
+            words?: components["schemas"]["WordTiming"][];
+            /** @description Font styling properties for inactive words. */
+            font?: components["schemas"]["RichTextFont"];
+            /** @description Text style properties including spacing, line height, and transformations. */
+            style?: components["schemas"]["RichTextStyle"];
+            /** @description Text stroke (outline) properties for inactive words. */
+            stroke?: components["schemas"]["RichTextStroke"];
+            /** @description Text shadow properties. */
+            shadow?: components["schemas"]["RichTextShadow"];
+            /** @description Background styling properties for the caption bounding box. */
+            background?: components["schemas"]["RichTextBackground"];
+            /** @description Padding inside the caption bounding box. Can be a single number (applied to all sides) or an object with individual sides. */
+            padding?: number | components["schemas"]["RichTextAsset"]["padding"]["oneOf"]["1"];
+            /** @description Text alignment properties (horizontal and vertical). */
+            align?: components["schemas"]["RichTextAlignment"];
+            /** @description Styling properties for the active/highlighted word. These override the base styling when a word is being spoken. */
+            active?: components["schemas"]["RichCaptionActive"];
+            /** @description Word-level animation properties controlling how words are highlighted or revealed. */
+            wordAnimation?: components["schemas"]["RichCaptionWordAnimation"];
+            /**
+             * @description Vertical position of the caption on screen.
+             * @default bottom
+             * @example bottom
+             * @enum {string}
+             */
+            position: "top" | "center" | "bottom";
+            /**
+             * @description Maximum width of the caption as a ratio of the frame width. Must be between 0.1 and 1.
+             * @default 0.9
+             * @example 0.85
+             */
+            maxWidth: number;
+            /**
+             * @description Maximum number of lines to display at once. Must be between 1 and 10.
+             * @default 2
+             * @example 2
+             */
+            maxLines: number;
+        };
+        /** @description Word-level timing information for caption animation. */
+        WordTiming: {
+            /**
+             * @description The word text to display.
+             * @example Hello
+             */
+            text: string;
+            /**
+             * @description Start time of the word in milliseconds.
+             * @example 0
+             */
+            start: number;
+            /**
+             * @description End time of the word in milliseconds.
+             * @example 400
+             */
+            end: number;
+            /**
+             * @description Speech-to-text confidence score between 0 and 1.
+             * @example 0.98
+             */
+            confidence?: number;
+        };
+        /** @description Font properties for the active/highlighted word. */
+        RichCaptionActiveFont: {
+            /**
+             * @description The active word color using hexadecimal color notation.
+             * @default #ffff00
+             * @example #ffff00
+             */
+            color: string;
+            /**
+             * @description The background color behind the active word using hexadecimal color notation.
+             * @example #000000
+             */
+            background?: string;
+            /**
+             * @description The opacity of the active word where 1 is opaque and 0 is transparent.
+             * @default 1
+             * @example 1
+             */
+            opacity: number;
+        };
+        /** @description Styling properties for the active/highlighted word. */
+        RichCaptionActive: {
+            /** @description Font properties for the active word. */
+            font?: components["schemas"]["RichCaptionActiveFont"];
+            /** @description Stroke properties for the active word. */
+            stroke?: components["schemas"]["RichTextStroke"];
+            /**
+             * @description Scale multiplier for the active word. 1.0 is normal size, 1.2 is 20% larger.
+             * @default 1
+             * @example 1.2
+             */
+            scale: number;
+        };
+        /** @description Word-level animation properties for caption effects. */
+        RichCaptionWordAnimation: {
+            /**
+             * @description The animation style to apply to words: <ul>
+             *       <li>`karaoke` - Word-by-word color fill as spoken (shows all words, highlights active)</li>
+             *       <li>`highlight` - Word changes to active color when spoken (shows all words)</li>
+             *       <li>`pop` - Each word scales up when active</li>
+             *       <li>`fade` - Gradual opacity transition per word</li>
+             *       <li>`slide` - Words slide in from a direction</li>
+             *       <li>`bounce` - Spring animation on word appearance</li>
+             *       <li>`typewriter` - Words appear one by one and stay visible</li>
+             *       <li>`none` - No animation, all words visible immediately</li>
+             *     </ul>
+             * @default karaoke
+             * @example karaoke
+             * @enum {string}
+             */
+            style: "karaoke" | "highlight" | "pop" | "fade" | "slide" | "bounce" | "typewriter" | "none";
+            /**
+             * @description Animation speed multiplier. 1.0 is normal speed, 0.5 is half speed, 2.0 is double speed.
+             * @default 1
+             * @example 1
+             */
+            speed: number;
+            /**
+             * @description Direction for directional animations (slide). Only applicable when style is `slide`.
+             * @default up
+             * @example up
+             * @enum {string}
+             */
+            direction: "left" | "right" | "up" | "down";
+        };
         /** @description The TextToImageAsset lets you create a dynamic image from a text prompt. */
         TextToImageAsset: {
             /**
-             * @description The type of asset to generate - set to `text-to-image` for text-to-image.
-             * @default text-to-image
+             * @description The type of asset to generate - set to `text-to-image` for text-to-image. (enum property replaced by openapi-typescript)
              * @enum {string}
              */
             type: "text-to-image";
@@ -2102,7 +2245,7 @@ export interface components {
             weight: unknown;
             /**
              * @description The text color using hexadecimal color notation.
-             * @default #ffffff
+             * @default #000000
              * @example #ff0000
              */
             color: string;
@@ -2128,6 +2271,12 @@ export interface components {
              * @example 2
              */
             letterSpacing: number;
+            /**
+             * @description Additional spacing between words in pixels. A value of 0 uses the font's natural space width.
+             * @default 0
+             * @example 10
+             */
+            wordSpacing: number;
             /**
              * @description The line height as a multiplier of the font size. Must be between 0 and 10.
              * @default 1.2