@shotstack/schemas 1.5.9 → 1.7.0

package/dist/json-schema/svg-transform.json

@@ -0,0 +1,93 @@
+{
+  "name": "SvgTransform",
+  "strict": true,
+  "schema": {
+    "description": "Transformation properties for positioning, rotating, and scaling SVG shapes.\n",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "x": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The x-coordinate position of the shape in pixels.\nRelative to the top-left corner of the viewport.\n"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "y": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The y-coordinate position of the shape in pixels.\nRelative to the top-left corner of the viewport.\n"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "rotation": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "Rotation angle in degrees. Positive values rotate clockwise,\nnegative values rotate counter-clockwise. Range: -360 to 360.\n",
+            "minimum": -360,
+            "maximum": 360
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "scale": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "Scale factor for the shape. `1` is original size, `2` is double size,\n`0.5` is half size. Must be greater than 0.\n",
+            "minimum": 0.01,
+            "maximum": 100
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "originX": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The x-coordinate of the transformation origin as a value from 0 to 1.\n`0` is the left edge, `0.5` is the center, `1` is the right edge.\n",
+            "minimum": 0,
+            "maximum": 1
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "originY": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The y-coordinate of the transformation origin as a value from 0 to 1.\n`0` is the top edge, `0.5` is the center, `1` is the bottom edge.\n",
+            "minimum": 0,
+            "maximum": 1
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "required": [
+      "x",
+      "y",
+      "rotation",
+      "scale",
+      "originX",
+      "originY"
+    ]
+  }
+}

package/dist/json-schema/text-to-image-asset.json

@@ -0,0 +1,128 @@
+{
+  "name": "TextToImageAsset",
+  "strict": true,
+  "schema": {
+    "description": "The TextToImageAsset lets you create a dynamic image from a text prompt.",
+    "properties": {
+      "type": {
+        "type": "string",
+        "description": "The type of asset to generate - set to `text-to-image` for text-to-image.",
+        "enum": [
+          "text-to-image"
+        ]
+      },
+      "prompt": {
+        "type": "string",
+        "description": "The text prompt to generate an image from."
+      },
+      "width": {
+        "anyOf": [
+          {
+            "type": "integer",
+            "description": "The width of the image in pixels."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "height": {
+        "anyOf": [
+          {
+            "type": "integer",
+            "description": "The height of the image in pixels."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "crop": {
+        "anyOf": [
+          {
+            "$ref": "#/$defs/Crop"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "additionalProperties": false,
+    "type": "object",
+    "required": [
+      "type",
+      "prompt",
+      "width",
+      "height",
+      "crop"
+    ],
+    "$defs": {
+      "Crop": {
+        "description": "Crop the sides of an asset by a relative amount. The size of the crop is specified using a scale between 0 and 1, relative to the screen width - i.e a left crop of 0.5 will crop half of the asset from the left, a top crop  of 0.25 will crop the top by quarter of the asset.",
+        "properties": {
+          "top": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "Crop from the top of the asset",
+                "minimum": 0,
+                "maximum": 1
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "bottom": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "Crop from the bottom of the asset",
+                "minimum": 0,
+                "maximum": 1
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "left": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "Crop from the left of the asset",
+                "minimum": 0,
+                "maximum": 1
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "right": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "Crop from the left of the asset",
+                "minimum": 0,
+                "maximum": 1
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "additionalProperties": false,
+        "type": "object",
+        "required": [
+          "top",
+          "bottom",
+          "left",
+          "right"
+        ]
+      }
+    }
+  }
+}

package/dist/json-schema/text-to-speech-asset.json

@@ -0,0 +1,209 @@
+{
+  "name": "TextToSpeechAsset",
+  "strict": true,
+  "schema": {
+    "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"
+        ]
+      },
+      "text": {
+        "type": "string",
+        "description": "The text to convert to speech."
+      },
+      "voice": {
+        "type": "string",
+        "description": "The voice to use for the text-to-speech conversion."
+      },
+      "language": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "The language code for the text-to-speech conversion."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "newscaster": {
+        "anyOf": [
+          {
+            "type": "boolean",
+            "description": "Set the voice to newscaster mode."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "trim": {
+        "anyOf": [
+          {
+            "type": "number",
+            "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": "null"
+          }
+        ]
+      },
+      "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.",
+        "anyOf": [
+          {
+            "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).",
+            "minimum": 0,
+            "maximum": 1
+          },
+          {
+            "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": "#/$defs/Tween"
+            }
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "speed": {
+        "anyOf": [
+          {
+            "type": "number",
+            "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.",
+            "minimum": 0,
+            "maximum": 10
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "effect": {
+        "anyOf": [
+          {
+            "type": "string",
+            "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": "null"
+          }
+        ]
+      }
+    },
+    "additionalProperties": false,
+    "required": [
+      "type",
+      "text",
+      "voice",
+      "language",
+      "newscaster",
+      "trim",
+      "volume",
+      "speed",
+      "effect"
+    ],
+    "$defs": {
+      "Tween": {
+        "description": "Use a Tween to [animate properties over time](/docs/guide/architecting-an-application/animations/). The following properties are currently supported and can be animated:\n  <ul>\n    <li>Opacity - animate the transparency of a clip.</li>\n    <li>Offset - animate the x and y position of a clip.</li>\n    <li>Rotation - animate the rotation of a clip.</li>\n    <li>Skew - animate the horizontal and vertical shearing effect.</li>\n    <li>Volume - animate the audio volume of a clip.</li>\n  </ul>",
+        "properties": {
+          "from": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "The initial property value at the start of the animation."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "to": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "The final property value at the end of the animation."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "start": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "The time in seconds when the animation starts, relative to the clip, not the timeline."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "length": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "The duration of the animation in seconds."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "interpolation": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "The interpolation method to use for the animation. Available options are: <ul>\n  <li>`linear` - a linear interpolation between the start and end values.</li>\n  <li>`bezier` - a bezier curve interpolation between the start and end values.</li>\n  <li>`constant` - an interpolation where the property instantly jumps from the start to the end value, without any gradual transition.</li>\n</ul>",
+                "enum": [
+                  "linear",
+                  "bezier",
+                  "constant"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "easing": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "The easing function to use for the animation. Easing controls the rate of change of the animated value, allowing for more natural motion by speeding up or slowing down the animation at different points. Only applicable if interpolation is set to `bezier`."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "additionalProperties": false,
+        "type": "object",
+        "required": [
+          "from",
+          "to",
+          "start",
+          "length",
+          "interpolation",
+          "easing"
+        ]
+      }
+    }
+  }
+}

package/dist/json-schema/thumbnail.json

@@ -0,0 +1,25 @@
+{
+  "name": "Thumbnail",
+  "strict": true,
+  "schema": {
+    "description": "Generate a thumbnail image for the video or image at a specific point from the timeline.",
+    "properties": {
+      "capture": {
+        "description": "The point on the timeline in seconds to capture a single frame to use as the thumbnail image.",
+        "type": "number"
+      },
+      "scale": {
+        "description": "Scale the thumbnail size to a fraction of the viewport size - i.e. setting the scale to 0.5 will scale  the thumbnail to half the size of the viewport.",
+        "type": "number",
+        "minimum": 0,
+        "maximum": 1
+      }
+    },
+    "additionalProperties": false,
+    "required": [
+      "capture",
+      "scale"
+    ],
+    "type": "object"
+  }
+}