@shotstack/schemas 1.6.0 → 1.7.1

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

@@ -0,0 +1,351 @@
+{
+  "name": "VideoAsset",
+  "strict": true,
+  "schema": {
+    "description": "The VideoAsset is used to create video sequences from video files. The ...",
+    "type": "object",
+    "properties": {
+      "type": {
+        "enum": [
+          "video"
+        ],
+        "description": "The type of asset -...",
+        "type": "string"
+      },
+      "src": {
+        "description": "The video source URL. The URL must be...",
+        "type": "string"
+      },
+      "transcode": {
+        "anyOf": [
+          {
+            "type": "boolean",
+            "description": "Set to `true` to force re-encoding of the video during preprocessing. This can help resolve compatibility issues, fix rotation ..."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "trim": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The start trim point of the video clip, in seconds (defaults to 0). Videos will start ..."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "volume": {
+        "description": "Set the volume of the video clip. Use a number or an array of...",
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The volume level for the video clip. Range varies from...",
+            "minimum": 0,
+            "maximum": 1
+          },
+          {
+            "type": "array",
+            "description": "An array of [Tween](./#tocs_tween) objects used to create...",
+            "items": {
+              "$ref": "#/$defs/Tween"
+            }
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "volumeEffect": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "Preset volume effects to apply to the video asset <ul>\n  <li>`fadeIn` - fade volume in only</li...",
+            "enum": [
+              "none",
+              "fadeIn",
+              "fadeOut",
+              "fadeInFadeOut"
+            ]
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "speed": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "Adjust the playback speed of the video 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 lengt...",
+            "minimum": 0,
+            "maximum": 10
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "crop": {
+        "anyOf": [
+          {
+            "$ref": "#/$defs/Crop"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "chromaKey": {
+        "anyOf": [
+          {
+            "$ref": "#/$defs/ChromaKey"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "additionalProperties": false,
+    "required": [
+      "type",
+      "src",
+      "transcode",
+      "trim",
+      "volume",
+      "volumeEffect",
+      "speed",
+      "crop",
+      "chromaKey"
+    ],
+    "$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    <l...",
+        "properties": {
+          "from": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "The initial property valu..."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "to": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "The final property valu..."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "start": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "The time in seconds when the animation ..."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "length": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "The duration of t..."
+              },
+              {
+                "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 ...",
+                "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 na...",
+                "enum": [
+                  "ease",
+                  "easeIn",
+                  "easeOut",
+                  "easeInOut",
+                  "easeInQuad",
+                  "easeInCubic",
+                  "easeInQuart",
+                  "easeInQuint",
+                  "easeInSine",
+                  "easeInExpo",
+                  "easeInCirc",
+                  "easeInBack",
+                  "easeOutQuad",
+                  "easeOutCubic",
+                  "easeOutQuart",
+                  "easeOutQuint",
+                  "easeOutSine",
+                  "easeOutExpo",
+                  "easeOutCirc",
+                  "easeOutBack",
+                  "easeInOutQuad",
+                  "easeInOutCubic",
+                  "easeInOutQuart",
+                  "easeInOutQuint",
+                  "easeInOutSine",
+                  "easeInOutExpo",
+                  "easeInOutCirc",
+                  "easeInOutBack"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "additionalProperties": false,
+        "type": "object",
+        "required": [
+          "from",
+          "to",
+          "start",
+          "length",
+          "interpolation",
+          "easing"
+        ]
+      },
+      "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 scr...",
+        "properties": {
+          "top": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "Crop from t...",
+                "minimum": 0,
+                "maximum": 1
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "bottom": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "Crop from the...",
+                "minimum": 0,
+                "maximum": 1
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "left": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "Crop from th...",
+                "minimum": 0,
+                "maximum": 1
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "right": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "Crop from th...",
+                "minimum": 0,
+                "maximum": 1
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "additionalProperties": false,
+        "type": "object",
+        "required": [
+          "top",
+          "bottom",
+          "left",
+          "right"
+        ]
+      },
+      "ChromaKey": {
+        "description": "Chroma key is a technique that replaces a specific color in a video with a different background image or vi...",
+        "properties": {
+          "color": {
+            "description": "The chroma key color as a hex value. Use green (#00b140) for green screens o...",
+            "type": "string"
+          },
+          "threshold": {
+            "anyOf": [
+              {
+                "type": "integer",
+                "description": "Pixels within this distance from the key color...",
+                "minimum": 0,
+                "maximum": 250
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "halo": {
+            "anyOf": [
+              {
+                "type": "integer",
+                "description": "Pixels within the halo distance from the threshold boundary are gi...",
+                "minimum": 0,
+                "maximum": 250
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "color",
+          "threshold",
+          "halo"
+        ],
+        "type": "object"
+      }
+    }
+  }
+}

package/dist/json-schema/vimeo-destination-options.json

@@ -0,0 +1,149 @@
+{
+  "name": "VimeoDestinationOptions",
+  "strict": true,
+  "schema": {
+    "description": "Pass additional options to control how Vimeo publishes video, including name, description and privacy settings.",
+    "properties": {
+      "name": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "A name or title for the video that will be displayed on the Vimeo website."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "description": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "A description of the video that will be displayed on the Vimeo website."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "privacy": {
+        "anyOf": [
+          {
+            "description": "Options to control the visibility of videos and privacy features.",
+            "$ref": "#/$defs/VimeoDestinationPrivacyOptions"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "folderUri": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "The Vimeo folder URI to upload the video to. The folder must already exist in your Vimeo account."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+      "name",
+      "description",
+      "privacy",
+      "folderUri"
+    ],
+    "$defs": {
+      "VimeoDestinationPrivacyOptions": {
+        "description": "Options to control the visibility of videos and privacy features.",
+        "properties": {
+          "view": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "Set who can view the videos. Available options are: <ul>\n  <li>`anybody` - Anyone can view the video.</li>\n  <li>`nobody` - Only the video owner can view the video.</li>\n  <li>`contacts` - Only contacts can view the video.</li>\n  <li>`password` - A password is required to view the video.</li>\n  <li>`unlisted` - The video is not listed on Vimeo.</li>\n</ul>",
+                "enum": [
+                  "anybody",
+                  "nobody",
+                  "contacts",
+                  "password",
+                  "unlisted"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "embed": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "Set who can embed the video. Available options are: <ul>\n  <li>`public` - Anyone can embed the video.</li>\n  <li>`private` - Only the video owner can embed the video.</li>\n  <li>`whitelist` - Only whitelisted domains can embed the video.</li>\n</ul>",
+                "enum": [
+                  "public",
+                  "private",
+                  "whitelist"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "comments": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "Set who can comment on the video. Available options are: <ul>\n  <li>`anybody` - Anyone can comment on the video.</li>\n  <li>`nobody` - Only the video owner can comment on the video.</li>\n  <li>`contacts` - Only contacts can comment on the video.</li>\n</ul>",
+                "enum": [
+                  "anybody",
+                  "nobody",
+                  "contacts"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "download": {
+            "anyOf": [
+              {
+                "type": "boolean",
+                "description": "Set whether the video can be downloaded."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "add": {
+            "anyOf": [
+              {
+                "type": "boolean",
+                "description": "Set whether other users can add the video to their collections."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "view",
+          "embed",
+          "comments",
+          "download",
+          "add"
+        ]
+      }
+    }
+  }
+}

package/dist/json-schema/vimeo-destination-privacy-options.json

@@ -0,0 +1,90 @@
+{
+  "name": "VimeoDestinationPrivacyOptions",
+  "strict": true,
+  "schema": {
+    "description": "Options to control the visibility of videos and privacy features.",
+    "properties": {
+      "view": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "Set who can view the videos. Available options are: <ul>\n  <li>`anybody` - Anyone can view the video.</li>\n  <li>`nobody` - Only the video owner can view the video.</li>\n  <li>`contacts` - Only contacts can view the video.</li>\n  <li>`password` - A password is required to view the video.</li>\n  <li>`unlisted` - The video is not listed on Vimeo.</li>\n</ul>",
+            "enum": [
+              "anybody",
+              "nobody",
+              "contacts",
+              "password",
+              "unlisted"
+            ]
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "embed": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "Set who can embed the video. Available options are: <ul>\n  <li>`public` - Anyone can embed the video.</li>\n  <li>`private` - Only the video owner can embed the video.</li>\n  <li>`whitelist` - Only whitelisted domains can embed the video.</li>\n</ul>",
+            "enum": [
+              "public",
+              "private",
+              "whitelist"
+            ]
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "comments": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "Set who can comment on the video. Available options are: <ul>\n  <li>`anybody` - Anyone can comment on the video.</li>\n  <li>`nobody` - Only the video owner can comment on the video.</li>\n  <li>`contacts` - Only contacts can comment on the video.</li>\n</ul>",
+            "enum": [
+              "anybody",
+              "nobody",
+              "contacts"
+            ]
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "download": {
+        "anyOf": [
+          {
+            "type": "boolean",
+            "description": "Set whether the video can be downloaded."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "add": {
+        "anyOf": [
+          {
+            "type": "boolean",
+            "description": "Set whether other users can add the video to their collections."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+      "view",
+      "embed",
+      "comments",
+      "download",
+      "add"
+    ]
+  }
+}