@shotstack/schemas 1.5.9 → 1.7.0

package/dist/json-schema/poster.json

@@ -0,0 +1,18 @@
+{
+  "name": "Poster",
+  "strict": true,
+  "schema": {
+    "description": "Generate a poster image for the video at a specific point from the timeline. The poster image size will match the size of the output video.",
+    "properties": {
+      "capture": {
+        "description": "The point on the timeline in seconds to capture a single frame to use as the poster image.",
+        "type": "number"
+      }
+    },
+    "additionalProperties": false,
+    "required": [
+      "capture"
+    ],
+    "type": "object"
+  }
+}

package/dist/json-schema/range.json

@@ -0,0 +1,39 @@
+{
+  "name": "Range",
+  "strict": true,
+  "schema": {
+    "description": "Specify a time range to render, i.e. to render only a portion of a video or audio file. Omit this setting to  export the entire video. Range can also be used to render a frame at a specific time point - setting a range and output format as `jpg` will output a single frame image at the range `start` point.",
+    "properties": {
+      "start": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The point on the timeline, in seconds, to start the render from - i.e. start at second 3.",
+            "minimum": 0
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "length": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The length of the portion of the video or audio to render - i.e. render 6 seconds of the video.",
+            "minimum": 0
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "additionalProperties": false,
+    "type": "object",
+    "required": [
+      "start",
+      "length"
+    ]
+  }
+}

package/dist/json-schema/rich-caption-active-font.json

@@ -0,0 +1,54 @@
+{
+  "name": "RichCaptionActiveFont",
+  "strict": true,
+  "schema": {
+    "description": "Font properties for the active/highlighted word.",
+    "type": "object",
+    "properties": {
+      "color": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "The active word color using hexadecimal color notation.",
+            "enum": [
+              "#ffff00"
+            ]
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "background": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "The background color behind the active word using hexadecimal color notation."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "opacity": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The opacity of the active word where 1 is opaque and 0 is transparent.",
+            "minimum": 0,
+            "maximum": 1
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "additionalProperties": false,
+    "required": [
+      "color",
+      "background",
+      "opacity"
+    ]
+  }
+}

package/dist/json-schema/rich-caption-active.json

@@ -0,0 +1,154 @@
+{
+  "name": "RichCaptionActive",
+  "strict": true,
+  "schema": {
+    "description": "Styling properties for the active/highlighted word.",
+    "type": "object",
+    "properties": {
+      "font": {
+        "anyOf": [
+          {
+            "description": "Font properties for the active word.",
+            "$ref": "#/$defs/RichCaptionActiveFont"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "stroke": {
+        "anyOf": [
+          {
+            "description": "Stroke properties for the active word.",
+            "$ref": "#/$defs/RichTextStroke"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "scale": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "Scale multiplier for the active word. 1.0 is normal size, 1.2 is 20% larger.",
+            "minimum": 0.5,
+            "maximum": 2
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "additionalProperties": false,
+    "required": [
+      "font",
+      "stroke",
+      "scale"
+    ],
+    "$defs": {
+      "RichCaptionActiveFont": {
+        "description": "Font properties for the active/highlighted word.",
+        "type": "object",
+        "properties": {
+          "color": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "The active word color using hexadecimal color notation.",
+                "enum": [
+                  "#ffff00"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "background": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "The background color behind the active word using hexadecimal color notation."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "opacity": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "The opacity of the active word where 1 is opaque and 0 is transparent.",
+                "minimum": 0,
+                "maximum": 1
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "color",
+          "background",
+          "opacity"
+        ]
+      },
+      "RichTextStroke": {
+        "description": "Text stroke (outline) properties.",
+        "properties": {
+          "width": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "The width of the stroke in pixels. Must be 0 or greater.",
+                "minimum": 0
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "color": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "The stroke color using hexadecimal color notation.",
+                "enum": [
+                  "#000000"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "opacity": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "The opacity of the stroke where 1 is opaque and 0 is transparent.",
+                "minimum": 0,
+                "maximum": 1
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "additionalProperties": false,
+        "type": "object",
+        "required": [
+          "width",
+          "color",
+          "opacity"
+        ]
+      }
+    }
+  }
+}