@shotstack/schemas 1.5.9 → 1.7.0

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

@@ -0,0 +1,180 @@
+{
+  "name": "AudioAsset",
+  "strict": true,
+  "schema": {
+    "description": "The AudioAsset is used to add sound effects and audio at specific intervals on the timeline. The src must be a publicly accessible URL to an audio resource such  as an mp3 file.",
+    "type": "object",
+    "properties": {
+      "type": {
+        "enum": [
+          "audio"
+        ],
+        "description": "The type of asset - set to `audio` for audio assets.",
+        "type": "string"
+      },
+      "src": {
+        "description": "The audio source URL. The URL must be publicly accessible or include credentials.",
+        "type": "string"
+      },
+      "trim": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The start trim point of the audio clip, in seconds (defaults to 0). Audio will start from the in 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. For example, if you set speed to 0.5, the clip will need to be 2x as long to play the entire audio (i.e. original length / 0.5). If you set speed to 2, the clip will need to be half as long to play the entire audio (i.e. original length / 2).",
+            "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",
+      "src",
+      "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/caption-asset.json

@@ -0,0 +1,285 @@
+{
+  "name": "CaptionAsset",
+  "strict": true,
+  "schema": {
+    "description": "The CaptionAsset is used to add captions (subtitles) to a video. It uses a supplied SRT or VTT file which will\nbe read and burnt to the video.\n\nCaptions can be applied independently from a video or audio file for greater\nflexibility with styling and layout. For example you can scale, position or crop a video without modifying the\ncaptions.\n\nTo sync captions with a video or audio file use a [Video](#tocs_videoasset\") or [Audio](#tocs_audioasset\") with\nmatching start and end time.\n",
+    "type": "object",
+    "properties": {
+      "type": {
+        "enum": [
+          "caption"
+        ],
+        "description": "The type of asset - set to `caption` for captions.",
+        "type": "string"
+      },
+      "src": {
+        "description": "The URL to an SRT or VTT subtitles file, or an alias reference to auto-generate captions from an audio or video clip. For file URLs, the URL must be publicly accessible or include credentials. For auto-captioning, use the format `alias://clip-name` where clip-name is the alias of an audio, video, or text-to-speech clip. The system will automatically transcribe the audio and detect the language.",
+        "type": "string"
+      },
+      "font": {
+        "anyOf": [
+          {
+            "description": "Font styling properties.",
+            "$ref": "#/$defs/CaptionFont"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "background": {
+        "anyOf": [
+          {
+            "description": "Background styling properties.",
+            "$ref": "#/$defs/CaptionBackground"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "margin": {
+        "anyOf": [
+          {
+            "description": "Margin properties.",
+            "$ref": "#/$defs/CaptionMargin"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "trim": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The start trim point of the captions, in seconds (defaults to 0). Remove the trim length from the start of the captions and allow it to be synced with video or audio. The captions will play until the file ends or the Clip length is reached."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "speed": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "Adjust the playback speed of the captions 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. For example, if you set speed to 0.5, the clip will need to be 2x as long to play the entire captions (i.e. original length / 0.5). If you set speed to 2, the clip will need to be half as long to play the entire captions (i.e. original length / 2).",
+            "minimum": 0,
+            "maximum": 10
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "additionalProperties": false,
+    "required": [
+      "type",
+      "src",
+      "font",
+      "background",
+      "margin",
+      "trim",
+      "speed"
+    ],
+    "$defs": {
+      "CaptionFont": {
+        "description": "Font properties for captions text.",
+        "properties": {
+          "family": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "The font family name. This must be Family name embedded in the font, i.e. \"Open Sans\"."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "color": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "The text color using hexadecimal color notation."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "opacity": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "The opacity of the text where 1 is opaque and 0 is transparent."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "size": {
+            "anyOf": [
+              {
+                "type": "integer",
+                "description": "The size of the font in pixels (px)."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "lineHeight": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "The line height of the font as a ratio of the font size."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "stroke": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "The stroke color of the font using hexadecimal color notation."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "strokeWidth": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "The width of the stroke in pixels."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "additionalProperties": false,
+        "type": "object",
+        "required": [
+          "family",
+          "color",
+          "opacity",
+          "size",
+          "lineHeight",
+          "stroke",
+          "strokeWidth"
+        ]
+      },
+      "CaptionBackground": {
+        "description": "Displays a background box behind the caption text.",
+        "properties": {
+          "color": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "The background color using hexadecimal color notation."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "opacity": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "The opacity of the background color."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "padding": {
+            "anyOf": [
+              {
+                "type": "integer",
+                "description": "The padding inside the background box in pixels."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "borderRadius": {
+            "anyOf": [
+              {
+                "type": "integer",
+                "description": "The border radius of the background box in pixels."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "additionalProperties": false,
+        "type": "object",
+        "required": [
+          "color",
+          "opacity",
+          "padding",
+          "borderRadius"
+        ]
+      },
+      "CaptionMargin": {
+        "description": "The margin properties for captions. Margins are used to position the caption text and background on the screen.",
+        "properties": {
+          "top": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "The margin above the text. Pushes captions down the screen."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "left": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "The margin to the left of the text. Pushes captions to the right."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "right": {
+            "anyOf": [
+              {
+                "type": "number",
+                "description": "The margin to the right of the text. Pushes captions to the left."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "additionalProperties": false,
+        "type": "object",
+        "required": [
+          "top",
+          "left",
+          "right"
+        ]
+      }
+    }
+  }
+}

package/dist/json-schema/caption-background.json

@@ -0,0 +1,61 @@
+{
+  "name": "CaptionBackground",
+  "strict": true,
+  "schema": {
+    "description": "Displays a background box behind the caption text.",
+    "properties": {
+      "color": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "The background color using hexadecimal color notation."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "opacity": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The opacity of the background color."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "padding": {
+        "anyOf": [
+          {
+            "type": "integer",
+            "description": "The padding inside the background box in pixels."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "borderRadius": {
+        "anyOf": [
+          {
+            "type": "integer",
+            "description": "The border radius of the background box in pixels."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "additionalProperties": false,
+    "type": "object",
+    "required": [
+      "color",
+      "opacity",
+      "padding",
+      "borderRadius"
+    ]
+  }
+}

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

@@ -0,0 +1,97 @@
+{
+  "name": "CaptionFont",
+  "strict": true,
+  "schema": {
+    "description": "Font properties for captions text.",
+    "properties": {
+      "family": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "The font family name. This must be Family name embedded in the font, i.e. \"Open Sans\"."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "color": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "The text color using hexadecimal color notation."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "opacity": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The opacity of the text where 1 is opaque and 0 is transparent."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "size": {
+        "anyOf": [
+          {
+            "type": "integer",
+            "description": "The size of the font in pixels (px)."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "lineHeight": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The line height of the font as a ratio of the font size."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "stroke": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "The stroke color of the font using hexadecimal color notation."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "strokeWidth": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The width of the stroke in pixels."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "additionalProperties": false,
+    "type": "object",
+    "required": [
+      "family",
+      "color",
+      "opacity",
+      "size",
+      "lineHeight",
+      "stroke",
+      "strokeWidth"
+    ]
+  }
+}

package/dist/json-schema/caption-margin.json

@@ -0,0 +1,49 @@
+{
+  "name": "CaptionMargin",
+  "strict": true,
+  "schema": {
+    "description": "The margin properties for captions. Margins are used to position the caption text and background on the screen.",
+    "properties": {
+      "top": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The margin above the text. Pushes captions down the screen."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "left": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The margin to the left of the text. Pushes captions to the right."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "right": {
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "The margin to the right of the text. Pushes captions to the left."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "additionalProperties": false,
+    "type": "object",
+    "required": [
+      "top",
+      "left",
+      "right"
+    ]
+  }
+}