@shotstack/schemas 1.6.0 → 1.7.0

package/dist/json-schema/offset.json

@@ -0,0 +1,145 @@
+{
+  "name": "Offset",
+  "strict": true,
+  "schema": {
+    "description": "Offsets the position of an asset horizontally or vertically by a relative distance.",
+    "properties": {
+      "x": {
+        "description": "Offset an asset on the horizontal axis (left or right). Use a number or an array of [Tween](./#tocs_tween) objects to create a custom animation.",
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "Range varies from -10 to 10. Positive numbers move the asset right, negative left. The distance moved is relative to the width  of the viewport - i.e. an X offset of 0.5 will move the asset half the screen width to the right.",
+            "minimum": -10,
+            "maximum": 10
+          },
+          {
+            "type": "array",
+            "description": "An array of [Tween](./#tocs_tween) objects used to create a custom animation. Animate the X offset of an asset over time.",
+            "items": {
+              "$ref": "#/$defs/Tween"
+            }
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "y": {
+        "description": "Offset an asset on the vertical axis (up or down). Use a number or an array of [Tween](./#tocs_tween) objects to create a custom animation.",
+        "anyOf": [
+          {
+            "type": "number",
+            "description": "Range varies from -10 to 10. Positive numbers move the asset up, negative down. The distance moved is relative to the height of the viewport - i.e. an Y offset of 0.5 will move the asset half the screen height up.",
+            "minimum": -10,
+            "maximum": 10
+          },
+          {
+            "type": "array",
+            "description": "An array of [Tween](./#tocs_tween) objects used to create a custom animation. Animate the Y offset of an asset over time.",
+            "items": {
+              "$ref": "#/$defs/Tween"
+            }
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "additionalProperties": false,
+    "type": "object",
+    "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"
+        ]
+      }
+    }
+  }
+}