@shotstack/schemas 1.5.2 → 1.5.4

package/dist/api.bundled.json

@@ -910,19 +910,6 @@
               "mount"
             ],
             "deprecated": true
-          },
-          "instance": {
-            "description": "The instance type to use for rendering. Different instance types have different capabilities and performance characteristics. Use `a1` for high-resolution 4K renders.",
-            "type": "string",
-            "example": "a1"
-          },
-          "poster": {
-            "description": "Generate a poster image from a specific point on the timeline.",
-            "$ref": "#/components/schemas/Poster"
-          },
-          "thumbnail": {
-            "description": "Generate a thumbnail image from a specific point on the timeline.",
-            "$ref": "#/components/schemas/Thumbnail"
           }
         },
         "required": [
@@ -1226,7 +1213,8 @@
             "shape": "#/components/schemas/ShapeAsset",
             "svg": "#/components/schemas/SvgAsset",
             "text-to-image": "#/components/schemas/TextToImageAsset",
-            "image-to-video": "#/components/schemas/ImageToVideoAsset"
+            "image-to-video": "#/components/schemas/ImageToVideoAsset",
+            "text-to-speech": "#/components/schemas/TextToSpeechAsset"
           }
         },
         "oneOf": [
@@ -1268,6 +1256,9 @@
           },
           {
             "$ref": "#/components/schemas/ImageToVideoAsset"
+          },
+          {
+            "$ref": "#/components/schemas/TextToSpeechAsset"
           }
         ],
         "additionalProperties": false
@@ -1499,7 +1490,7 @@
             "$ref": "#/components/schemas/RichTextStyle"
           },
           "stroke": {
-            "description": "Text stroke (outline) properties for the text.",
+            "description": "Text stroke (outline) properties.",
             "$ref": "#/components/schemas/RichTextStroke"
           },
           "shadow": {
@@ -1967,6 +1958,87 @@
           "src"
         ]
       },
+      "TextToSpeechAsset": {
+        "description": "The TextToSpeechAsset lets you generate a voice over from text using a text-to-speech service. The generated audio can be trimmed, faded and have its volume and speed adjusted using the same properties available on the AudioAsset.",
+        "type": "object",
+        "properties": {
+          "type": {
+            "type": "string",
+            "description": "The type of asset - set to `text-to-speech` for text-to-speech.",
+            "enum": [
+              "text-to-speech"
+            ],
+            "default": "text-to-speech"
+          },
+          "text": {
+            "type": "string",
+            "description": "The text to convert to speech.",
+            "example": "This is a text to speech example generated by Shotstack"
+          },
+          "voice": {
+            "type": "string",
+            "description": "The voice to use for the text-to-speech conversion.",
+            "example": "Matthew"
+          },
+          "language": {
+            "type": "string",
+            "description": "The language code for the text-to-speech conversion.",
+            "example": "en-US"
+          },
+          "newscaster": {
+            "type": "boolean",
+            "description": "Set the voice to newscaster mode.",
+            "default": false
+          },
+          "trim": {
+            "description": "The start trim point of the audio clip, in seconds (defaults to 0). Audio will start from the trim point. The audio will play until the file ends or the Clip length is reached.",
+            "type": "number"
+          },
+          "volume": {
+            "description": "Set the volume of the audio clip. Use a number or an array of [Tween](./#tocs_tween) objects to create custom volume transitions.",
+            "oneOf": [
+              {
+                "type": "number",
+                "description": "The volume level for the audio clip. Range varies from 0 to 1 where 0 is muted and 1 is full volume (defaults to 1).",
+                "format": "float",
+                "minimum": 0,
+                "maximum": 1,
+                "example": 0.5
+              },
+              {
+                "type": "array",
+                "description": "An array of [Tween](./#tocs_tween) objects used to create a custom volume effect. Modify the volume of an asset over time.",
+                "items": {
+                  "$ref": "#/components/schemas/Tween"
+                }
+              }
+            ]
+          },
+          "speed": {
+            "description": "Adjust the playback speed of the audio clip between 0 (paused) and 10 (10x normal speed), where 1 is normal speed (defaults to 1). Adjusting the speed will also adjust the duration of the clip and may require you to adjust the Clip length.",
+            "type": "number",
+            "format": "float",
+            "minimum": 0,
+            "maximum": 10,
+            "example": 1
+          },
+          "effect": {
+            "description": "The effect to apply to the audio asset <ul>\n  <li>`fadeIn` - fade volume in only</li>\n  <li>`fadeOut` - fade volume out only</li>\n  <li>`fadeInFadeOut` - fade volume in and out</li>\n</ul>",
+            "enum": [
+              "none",
+              "fadeIn",
+              "fadeOut",
+              "fadeInFadeOut"
+            ],
+            "type": "string"
+          }
+        },
+        "required": [
+          "type",
+          "text",
+          "voice"
+        ]
+      },
       "HtmlAsset": {
         "deprecated": true,
         "description": "**Notice: The HtmlAsset is deprecated, use the [TextAsset](#tocs_textasset) instead.**\n\nThe HtmlAsset clip type lets you create text based layout and formatting using\nHTML and CSS. You can also set the height and width of a bounding box for the HTML\ncontent to sit within. Text and elements will wrap within the bounding box.\n",
@@ -3762,11 +3834,6 @@
             "type": "number",
             "example": 0.25
           },
-          "bottom": {
-            "description": "The margin below the text. Pushes captions up the screen.",
-            "type": "number",
-            "example": 0.25
-          },
           "left": {
             "description": "The margin to the left of the text. Pushes captions to the right.",
             "type": "number",

package/dist/schema.d.ts

@@ -448,15 +448,6 @@ export interface components {
              * @enum {string}
              */
             disk?: "local" | "mount";
-            /**
-             * @description The instance type to use for rendering. Different instance types have different capabilities and performance characteristics. Use `a1` for high-resolution 4K renders.
-             * @example a1
-             */
-            instance?: string;
-            /** @description Generate a poster image from a specific point on the timeline. */
-            poster?: components["schemas"]["Poster"];
-            /** @description Generate a thumbnail image from a specific point on the timeline. */
-            thumbnail?: components["schemas"]["Thumbnail"];
         };
         /** @description A timeline represents the contents of a video edit over time, an audio edit over time, in seconds, or an image layout. A timeline consists of layers called tracks. Tracks are composed of titles, images, audio, html or video segments referred to as clips which are placed along the track at specific starting point and lasting for a specific amount of time. */
         Timeline: {
@@ -592,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"];
+        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"];
         /** @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: {
             /**
@@ -734,7 +725,7 @@ export interface components {
             font?: components["schemas"]["RichTextFont"];
             /** @description Text style properties including spacing, line height, and transformations. */
             style?: components["schemas"]["RichTextStyle"];
-            /** @description Text stroke (outline) properties for the text. */
+            /** @description Text stroke (outline) properties. */
             stroke?: components["schemas"]["RichTextStroke"];
             /** @description Text shadow properties. */
             shadow?: components["schemas"]["RichTextShadow"];
@@ -1033,6 +1024,53 @@ export interface components {
             speed?: number;
             crop?: components["schemas"]["Crop"];
         };
+        /** @description The TextToSpeechAsset lets you generate a voice over from text using a text-to-speech service. The generated audio can be trimmed, faded and have its volume and speed adjusted using the same properties available on the AudioAsset. */
+        TextToSpeechAsset: {
+            /**
+             * @description The type of asset - set to `text-to-speech` for text-to-speech. (enum property replaced by openapi-typescript)
+             * @enum {string}
+             */
+            type: "text-to-speech";
+            /**
+             * @description The text to convert to speech.
+             * @example This is a text to speech example generated by Shotstack
+             */
+            text: string;
+            /**
+             * @description The voice to use for the text-to-speech conversion.
+             * @example Matthew
+             */
+            voice: string;
+            /**
+             * @description The language code for the text-to-speech conversion.
+             * @example en-US
+             */
+            language?: string;
+            /**
+             * @description Set the voice to newscaster mode.
+             * @default false
+             */
+            newscaster: boolean;
+            /** @description The start trim point of the audio clip, in seconds (defaults to 0). Audio will start from the trim point. The audio will play until the file ends or the Clip length is reached. */
+            trim?: number;
+            /** @description Set the volume of the audio clip. Use a number or an array of [Tween](./#tocs_tween) objects to create custom volume transitions. */
+            volume?: number | components["schemas"]["Tween"][];
+            /**
+             * Format: float
+             * @description Adjust the playback speed of the audio clip between 0 (paused) and 10 (10x normal speed), where 1 is normal speed (defaults to 1). Adjusting the speed will also adjust the duration of the clip and may require you to adjust the Clip length.
+             * @example 1
+             */
+            speed?: number;
+            /**
+             * @description The effect to apply to the audio asset <ul>
+             *       <li>`fadeIn` - fade volume in only</li>
+             *       <li>`fadeOut` - fade volume out only</li>
+             *       <li>`fadeInFadeOut` - fade volume in and out</li>
+             *     </ul>
+             * @enum {string}
+             */
+            effect?: "none" | "fadeIn" | "fadeOut" | "fadeInFadeOut";
+        };
         /**
          * @deprecated
          * @description **Notice: The HtmlAsset is deprecated, use the [TextAsset](#tocs_textasset) instead.**
@@ -2339,11 +2377,6 @@ export interface components {
              * @example 0.25
              */
             top?: number;
-            /**
-             * @description The margin below the text. Pushes captions up the screen.
-             * @example 0.25
-             */
-            bottom?: number;
             /**
              * @description The margin to the left of the text. Pushes captions to the right.
              * @example 0.05