@shotstack/schemas 1.8.6 → 1.9.0

package/dist/json-schema/schemas.json

@@ -2024,35 +2024,118 @@
           "type": "string"
         },
         "src": {
-          "anyOf": [
-            {
-              "type": "string",
-              "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. Mutually exclusive with `words`."
-            },
-            {
-              "type": "null"
-            }
-          ]
-        },
-        "words": {
-          "anyOf": [
-            {
-              "type": "array",
-              "description": "Pre-provided word-level timing data. Use this instead of `src` when you have word timestamps from an external source. Mutually exclusive with `src`.",
-              "items": {
-                "$ref": "#/$defs/WordTiming"
-              }
-            },
-            {
-              "type": "null"
-            }
-          ]
+          "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.",
+          "type": "string"
         },
         "font": {
           "anyOf": [
             {
+              "type": "object",
               "description": "Font styling properties for inactive words.",
-              "$ref": "#/$defs/RichTextFont"
+              "properties": {
+                "family": {
+                  "anyOf": [
+                    {
+                      "type": "string",
+                      "description": "The font family name. This must be the Family name embedded in the font, i.e. \"Roboto\".",
+                      "enum": [
+                        "Roboto"
+                      ]
+                    },
+                    {
+                      "type": "null"
+                    }
+                  ]
+                },
+                "size": {
+                  "anyOf": [
+                    {
+                      "type": "integer",
+                      "description": "The size of the font in pixels (px). Must be between 1 and 500.",
+                      "minimum": 1,
+                      "maximum": 500
+                    },
+                    {
+                      "type": "null"
+                    }
+                  ]
+                },
+                "weight": {
+                  "anyOf": [
+                    {
+                      "type": "string",
+                      "description": "The weight of the font. Can be a number (100-900) or a string ('normal', 'bold', etc.). 100 is lightest, 900 is heaviest (boldest)."
+                    },
+                    {
+                      "type": "null"
+                    }
+                  ]
+                },
+                "color": {
+                  "anyOf": [
+                    {
+                      "type": "string",
+                      "description": "The text color using hexadecimal color notation.",
+                      "enum": [
+                        "#ffffff"
+                      ]
+                    },
+                    {
+                      "type": "null"
+                    }
+                  ]
+                },
+                "opacity": {
+                  "anyOf": [
+                    {
+                      "type": "number",
+                      "description": "The opacity of the text where 1 is opaque and 0 is transparent.",
+                      "minimum": 0,
+                      "maximum": 1
+                    },
+                    {
+                      "type": "null"
+                    }
+                  ]
+                },
+                "background": {
+                  "anyOf": [
+                    {
+                      "type": "string",
+                      "description": "The background color behind the text using hexadecimal color notation."
+                    },
+                    {
+                      "type": "null"
+                    }
+                  ]
+                },
+                "textDecoration": {
+                  "anyOf": [
+                    {
+                      "type": "string",
+                      "description": "Text decoration to apply to all words.",
+                      "enum": [
+                        "none",
+                        "underline",
+                        "line-through"
+                      ]
+                    },
+                    {
+                      "type": "null"
+                    }
+                  ]
+                }
+              },
+              "additionalProperties": false,
+              "required": [
+                "family",
+                "size",
+                "weight",
+                "color",
+                "opacity",
+                "background",
+                "textDecoration"
+              ]
             },
             {
               "type": "null"
@@ -2103,6 +2186,17 @@
             }
           ]
         },
+        "border": {
+          "anyOf": [
+            {
+              "description": "Border styling properties for the caption bounding box.",
+              "$ref": "#/$defs/RichTextAsset/properties/border"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
         "padding": {
           "description": "Padding inside the caption bounding box. Can be a single number (applied to all sides) or an object with individual sides.",
           "anyOf": [
@@ -2151,107 +2245,22 @@
               "type": "null"
             }
           ]
-        },
-        "position": {
-          "anyOf": [
-            {
-              "type": "string",
-              "description": "Vertical position of the caption on screen.",
-              "enum": [
-                "top",
-                "center",
-                "bottom"
-              ]
-            },
-            {
-              "type": "null"
-            }
-          ]
-        },
-        "maxWidth": {
-          "anyOf": [
-            {
-              "type": "number",
-              "description": "Maximum width of the caption as a ratio of the frame width. Must be between 0.1 and 1.",
-              "minimum": 0.1,
-              "maximum": 1
-            },
-            {
-              "type": "null"
-            }
-          ]
-        },
-        "maxLines": {
-          "anyOf": [
-            {
-              "type": "integer",
-              "description": "Maximum number of lines to display at once. Must be between 1 and 10.",
-              "minimum": 1,
-              "maximum": 10
-            },
-            {
-              "type": "null"
-            }
-          ]
         }
       },
       "additionalProperties": false,
       "required": [
         "type",
         "src",
-        "words",
         "font",
         "style",
         "stroke",
         "shadow",
         "background",
+        "border",
         "padding",
         "align",
         "active",
-        "wordAnimation",
-        "position",
-        "maxWidth",
-        "maxLines"
-      ]
-    },
-    "WordTiming": {
-      "description": "Word-level timing information for caption animation.",
-      "type": "object",
-      "properties": {
-        "text": {
-          "description": "The word text to display.",
-          "type": "string"
-        },
-        "start": {
-          "description": "Start time of the word in milliseconds.",
-          "type": "number",
-          "minimum": 0
-        },
-        "end": {
-          "description": "End time of the word in milliseconds.",
-          "type": "number",
-          "minimum": 0
-        },
-        "confidence": {
-          "anyOf": [
-            {
-              "type": "number",
-              "description": "Speech-to-text confidence score between 0 and 1.",
-              "minimum": 0,
-              "maximum": 1
-            },
-            {
-              "type": "null"
-            }
-          ]
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "text",
-        "start",
-        "end",
-        "confidence"
+        "wordAnimation"
       ]
     },
     "RichCaptionActive": {
@@ -2280,6 +2289,17 @@
             }
           ]
         },
+        "shadow": {
+          "anyOf": [
+            {
+              "description": "Shadow properties for the active word. Overrides the base shadow when a word is active.",
+              "$ref": "#/$defs/RichTextShadow"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
         "scale": {
           "anyOf": [
             {
@@ -2298,6 +2318,7 @@
       "required": [
         "font",
         "stroke",
+        "shadow",
         "scale"
       ]
     },
@@ -2342,13 +2363,30 @@
               "type": "null"
             }
           ]
+        },
+        "textDecoration": {
+          "anyOf": [
+            {
+              "type": "string",
+              "description": "Text decoration to apply to the active word.",
+              "enum": [
+                "none",
+                "underline",
+                "line-through"
+              ]
+            },
+            {
+              "type": "null"
+            }
+          ]
         }
       },
       "additionalProperties": false,
       "required": [
         "color",
         "background",
-        "opacity"
+        "opacity",
+        "textDecoration"
       ]
     },
     "RichCaptionWordAnimation": {

package/dist/json-schema/timeline.json

@@ -1854,32 +1854,109 @@
             "type": "string"
           },
           "src": {
-            "anyOf": [
-              {
-                "type": "string"
-              },
-              {
-                "type": "null"
-              }
-            ]
-          },
-          "words": {
-            "anyOf": [
-              {
-                "type": "array",
-                "items": {
-                  "$ref": "#/$defs/WordTiming"
-                }
-              },
-              {
-                "type": "null"
-              }
-            ]
+            "type": "string"
           },
           "font": {
             "anyOf": [
               {
-                "$ref": "#/$defs/RichTextFont"
+                "type": "object",
+                "properties": {
+                  "family": {
+                    "anyOf": [
+                      {
+                        "type": "string",
+                        "enum": [
+                          "Roboto"
+                        ]
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "size": {
+                    "anyOf": [
+                      {
+                        "type": "integer",
+                        "minimum": 1,
+                        "maximum": 500
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "weight": {
+                    "anyOf": [
+                      {
+                        "type": "string"
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "color": {
+                    "anyOf": [
+                      {
+                        "type": "string",
+                        "enum": [
+                          "#ffffff"
+                        ]
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "opacity": {
+                    "anyOf": [
+                      {
+                        "type": "number",
+                        "minimum": 0,
+                        "maximum": 1
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "background": {
+                    "anyOf": [
+                      {
+                        "type": "string"
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "textDecoration": {
+                    "anyOf": [
+                      {
+                        "type": "string",
+                        "enum": [
+                          "none",
+                          "underline",
+                          "line-through"
+                        ]
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  }
+                },
+                "additionalProperties": false,
+                "required": [
+                  "family",
+                  "size",
+                  "weight",
+                  "color",
+                  "opacity",
+                  "background",
+                  "textDecoration"
+                ]
               },
               {
                 "type": "null"
@@ -1926,6 +2003,16 @@
               }
             ]
           },
+          "border": {
+            "anyOf": [
+              {
+                "$ref": "#/$defs/RichTextAsset/properties/border"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
           "padding": {
             "anyOf": [
               {
@@ -1969,118 +2056,51 @@
                 "type": "null"
               }
             ]
-          },
-          "position": {
-            "anyOf": [
-              {
-                "type": "string",
-                "enum": [
-                  "top",
-                  "center",
-                  "bottom"
-                ]
-              },
-              {
-                "type": "null"
-              }
-            ]
-          },
-          "maxWidth": {
-            "anyOf": [
-              {
-                "type": "number",
-                "minimum": 0.1,
-                "maximum": 1
-              },
-              {
-                "type": "null"
-              }
-            ]
-          },
-          "maxLines": {
-            "anyOf": [
-              {
-                "type": "integer",
-                "minimum": 1,
-                "maximum": 10
-              },
-              {
-                "type": "null"
-              }
-            ]
           }
         },
         "additionalProperties": false,
         "required": [
           "type",
           "src",
-          "words",
           "font",
           "style",
           "stroke",
           "shadow",
           "background",
+          "border",
           "padding",
           "align",
           "active",
-          "wordAnimation",
-          "position",
-          "maxWidth",
-          "maxLines"
+          "wordAnimation"
         ]
       },
-      "WordTiming": {
+      "RichCaptionActive": {
         "type": "object",
         "properties": {
-          "text": {
-            "type": "string"
-          },
-          "start": {
-            "type": "number",
-            "minimum": 0
-          },
-          "end": {
-            "type": "number",
-            "minimum": 0
-          },
-          "confidence": {
+          "font": {
             "anyOf": [
               {
-                "type": "number",
-                "minimum": 0,
-                "maximum": 1
+                "$ref": "#/$defs/RichCaptionActiveFont"
               },
               {
                 "type": "null"
               }
             ]
-          }
-        },
-        "additionalProperties": false,
-        "required": [
-          "text",
-          "start",
-          "end",
-          "confidence"
-        ]
-      },
-      "RichCaptionActive": {
-        "type": "object",
-        "properties": {
-          "font": {
+          },
+          "stroke": {
             "anyOf": [
               {
-                "$ref": "#/$defs/RichCaptionActiveFont"
+                "$ref": "#/$defs/RichTextStroke"
               },
               {
                 "type": "null"
               }
             ]
           },
-          "stroke": {
+          "shadow": {
             "anyOf": [
               {
-                "$ref": "#/$defs/RichTextStroke"
+                "$ref": "#/$defs/RichTextShadow"
               },
               {
                 "type": "null"
@@ -2104,6 +2124,7 @@
         "required": [
           "font",
           "stroke",
+          "shadow",
           "scale"
         ]
       },
@@ -2144,13 +2165,29 @@
                 "type": "null"
               }
             ]
+          },
+          "textDecoration": {
+            "anyOf": [
+              {
+                "type": "string",
+                "enum": [
+                  "none",
+                  "underline",
+                  "line-through"
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
           }
         },
         "additionalProperties": false,
         "required": [
           "color",
           "background",
-          "opacity"
+          "opacity",
+          "textDecoration"
         ]
       },
       "RichCaptionWordAnimation": {