@shotstack/schemas 1.6.0 → 1.7.0

package/dist/json-schema/shape-asset.json

@@ -0,0 +1,225 @@
+{
+  "name": "ShapeAsset",
+  "strict": true,
+  "schema": {
+    "description": "The ShapeAsset is used to add shapes to a video. The shape can be styled with a fill and a stroke.\nYou can manipulate properties such as rotation to create dynamic effects like a diamond shape or stripes.\n",
+    "type": "object",
+    "properties": {
+      "type": {
+        "enum": [
+          "shape"
+        ],
+        "description": "The type of asset - set to `shape` for shape.",
+        "type": "string"
+      },
+      "shape": {
+        "description": "The shape to display.",
+        "type": "string",
+        "enum": [
+          "rectangle",
+          "circle",
+          "line"
+        ]
+      },
+      "width": {
+        "anyOf": [
+          {
+            "type": "integer",
+            "description": "Sets the width of the bounding box in pixels. This value should be larger than the shape's width. If omitted, the entire viewport width and height will be used."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "height": {
+        "anyOf": [
+          {
+            "type": "integer",
+            "description": "Sets the height of the bounding box in pixels. This value should be larger than the shape's height. If omitted, the entire viewport width and height will be used."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "fill": {
+        "anyOf": [
+          {
+            "type": "object",
+            "description": "Specifies the fill style of the shape.",
+            "properties": {
+              "color": {
+                "anyOf": [
+                  {
+                    "type": "string",
+                    "description": "The color of the fill using hexadecimal color notation."
+                  },
+                  {
+                    "type": "null"
+                  }
+                ]
+              },
+              "opacity": {
+                "anyOf": [
+                  {
+                    "type": "number",
+                    "description": "The opacity of the fill where 1 is opaque and 0 is transparent."
+                  },
+                  {
+                    "type": "null"
+                  }
+                ]
+              }
+            },
+            "additionalProperties": false,
+            "required": [
+              "color",
+              "opacity"
+            ]
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "stroke": {
+        "anyOf": [
+          {
+            "type": "object",
+            "description": "Specifies the stroke style of the shape.",
+            "properties": {
+              "color": {
+                "anyOf": [
+                  {
+                    "type": "string",
+                    "description": "The stroke color of the font using hexadecimal color notation."
+                  },
+                  {
+                    "type": "null"
+                  }
+                ]
+              },
+              "width": {
+                "anyOf": [
+                  {
+                    "type": "number",
+                    "description": "The width of the stroke in pixels."
+                  },
+                  {
+                    "type": "null"
+                  }
+                ]
+              }
+            },
+            "additionalProperties": false,
+            "required": [
+              "color",
+              "width"
+            ]
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "rectangle": {
+        "anyOf": [
+          {
+            "type": "object",
+            "description": "Configuration settings for the rectangle shape. Required when `shape` is set to `rectangle`.",
+            "properties": {
+              "width": {
+                "description": "Set the width of the rectangle shape in pixels.",
+                "type": "integer"
+              },
+              "height": {
+                "description": "Set the height of the rectangle shape in pixels.",
+                "type": "integer"
+              },
+              "cornerRadius": {
+                "anyOf": [
+                  {
+                    "type": "integer",
+                    "description": "Set the corner radius of the rectangle shape."
+                  },
+                  {
+                    "type": "null"
+                  }
+                ]
+              }
+            },
+            "additionalProperties": false,
+            "required": [
+              "width",
+              "height",
+              "cornerRadius"
+            ]
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "circle": {
+        "anyOf": [
+          {
+            "type": "object",
+            "description": "Configuration settings for the circle shape. Required when `shape` is set to `circle`.",
+            "properties": {
+              "radius": {
+                "description": "Set the radius of the circle shape in pixels.",
+                "type": "integer"
+              }
+            },
+            "additionalProperties": false,
+            "required": [
+              "radius"
+            ]
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "line": {
+        "anyOf": [
+          {
+            "type": "object",
+            "description": "Configuration settings for the line shape. Required when `shape` is set to `line`.",
+            "properties": {
+              "length": {
+                "description": "Set the length of the line shape in pixels.",
+                "type": "integer"
+              },
+              "thickness": {
+                "description": "Set the thickness of the line in pixels.",
+                "type": "integer"
+              }
+            },
+            "additionalProperties": false,
+            "required": [
+              "length",
+              "thickness"
+            ]
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "additionalProperties": false,
+    "required": [
+      "type",
+      "shape",
+      "width",
+      "height",
+      "fill",
+      "stroke",
+      "rectangle",
+      "circle",
+      "line"
+    ]
+  }
+}

package/dist/json-schema/shotstack-destination.json

@@ -0,0 +1,33 @@
+{
+  "name": "ShotstackDestination",
+  "strict": true,
+  "schema": {
+    "description": "Send videos and assets to the  [Shotstack hosting and CDN](https://shotstack.io/docs/guide/serving-assets/destinations/shotstack/) service.  This destination is enabled by default.",
+    "properties": {
+      "provider": {
+        "description": "The destination to send assets to - set to `shotstack` for Shotstack hosting and CDN.",
+        "type": "string",
+        "enum": [
+          "shotstack"
+        ]
+      },
+      "exclude": {
+        "anyOf": [
+          {
+            "type": "boolean",
+            "description": "Set to `true` to [opt-out](https://shotstack.io/docs/guide/serving-assets/self-host/) from the Shotstack hosting and CDN service. All files must be downloaded within 24 hours of rendering."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "type": "object",
+    "required": [
+      "provider",
+      "exclude"
+    ],
+    "additionalProperties": false
+  }
+}

package/dist/json-schema/size.json

@@ -0,0 +1,41 @@
+{
+  "name": "Size",
+  "strict": true,
+  "schema": {
+    "description": "Set a custom size for a video or image in pixels. When using a custom size omit the `resolution` and `aspectRatio`. Custom sizes must be divisible by 2 based on the encoder specifications.",
+    "properties": {
+      "width": {
+        "anyOf": [
+          {
+            "type": "integer",
+            "description": "Set a custom width for the video or image file in pixels. Value must be divisible by 2. Maximum video width is 1920px, maximum image width is 4096px.",
+            "minimum": 1,
+            "maximum": 4096
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "height": {
+        "anyOf": [
+          {
+            "type": "integer",
+            "description": "Set a custom height for the video or image file in pixels. Value must be divisible by 2. Maximum video height is 1920px, maximum image height is 4096px.",
+            "minimum": 1,
+            "maximum": 4096
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "additionalProperties": false,
+    "type": "object",
+    "required": [
+      "width",
+      "height"
+    ]
+  }
+}

package/dist/json-schema/skew-transformation.json

@@ -0,0 +1,145 @@
+{
+  "name": "SkewTransformation",
+  "strict": true,
+  "schema": {
+    "description": "Skew a clip so its edges are sheared at an angle. Use values between -100 and 100. Values over 3 or under -3 will skew the clip almost flat.",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "x": {
+        "description": "Skew the clip along it's x axis.",
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "Range varies from -100 to 100. Positive numbers skew the asset right, negative left. The distance moved is relative to the width of the viewport - i.e. an X skew of 0.5 will skew the asset half the screen width to the right.",
+            "minimum": -100,
+            "maximum": 100
+          },
+          {
+            "type": "array",
+            "description": "An array of [Tween](./#tocs_tween) objects used to create a custom animation. Animate the X skew of an asset over time.",
+            "items": {
+              "$ref": "#/$defs/Tween"
+            }
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "y": {
+        "description": "Skew the clip along it's y axis.",
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "Range varies from -100 to 100. Positive numbers skew the asset up, negative down. The distance moved is relative to the height of the viewport - i.e. an Y skew of 0.5 will skew the asset half the screen height up.",
+            "minimum": -100,
+            "maximum": 100
+          },
+          {
+            "type": "array",
+            "description": "An array of [Tween](./#tocs_tween) objects used to create a custom animation. Animate the Y skew of an asset over time.",
+            "items": {
+              "$ref": "#/$defs/Tween"
+            }
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "required": [
+      "x",
+      "y"
+    ],
+    "$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/soundtrack.json

@@ -0,0 +1,47 @@
+{
+  "name": "Soundtrack",
+  "strict": true,
+  "schema": {
+    "description": "A music or audio file in mp3 format that plays for the duration of the rendered video or the length of the audio file, which ever is shortest.",
+    "properties": {
+      "src": {
+        "description": "The URL of the mp3 audio file. The URL must be publicly accessible or include credentials.",
+        "type": "string"
+      },
+      "effect": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "The effect to apply to the audio file <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": [
+              "fadeIn",
+              "fadeOut",
+              "fadeInFadeOut"
+            ]
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "volume": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "Set the volume for the soundtrack between 0 and 1 where 0 is muted and 1 is full volume (defaults to 1)."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "additionalProperties": false,
+    "required": [
+      "src",
+      "effect",
+      "volume"
+    ],
+    "type": "object"
+  }
+}

package/dist/json-schema/svg-arrow-shape.json

@@ -0,0 +1,49 @@
+{
+  "name": "SvgArrowShape",
+  "strict": true,
+  "schema": {
+    "description": "An arrow shape pointing to the right by default.\nUse transform rotation to change direction.\n",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "type": {
+        "description": "The shape type - set to `arrow`.",
+        "type": "string",
+        "enum": [
+          "arrow"
+        ]
+      },
+      "length": {
+        "description": "The total length of the arrow from tail to tip in pixels.",
+        "type": "number",
+        "minimum": 1,
+        "maximum": 4096
+      },
+      "headWidth": {
+        "description": "The width of the arrow head (the widest part) in pixels.",
+        "type": "number",
+        "minimum": 1,
+        "maximum": 1000
+      },
+      "headLength": {
+        "description": "The length of the arrow head portion in pixels.",
+        "type": "number",
+        "minimum": 1,
+        "maximum": 1000
+      },
+      "shaftWidth": {
+        "description": "The width of the arrow shaft (body) in pixels.",
+        "type": "number",
+        "minimum": 1,
+        "maximum": 1000
+      }
+    },
+    "required": [
+      "type",
+      "length",
+      "headWidth",
+      "headLength",
+      "shaftWidth"
+    ]
+  }
+}