@shotstack/schemas 1.23.4 → 1.24.0-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api.bundled.json +608 -0
- package/dist/json-schema/edit.json +631 -0
- package/dist/json-schema/index.cjs +1 -1
- package/dist/json-schema/index.js +1 -1
- package/dist/schema.d.ts +132 -0
- package/dist/zod/zod.gen.cjs +292 -7
- package/dist/zod/zod.gen.d.ts +51888 -23587
- package/dist/zod/zod.gen.js +286 -1
- package/dist/zod/zod.gen.ts +196 -1
- package/package.json +1 -1
|
@@ -194,6 +194,9 @@
|
|
|
194
194
|
"fadeInFadeOut"
|
|
195
195
|
],
|
|
196
196
|
"type": "string"
|
|
197
|
+
},
|
|
198
|
+
"duck": {
|
|
199
|
+
"$ref": "#/$defs/Duck"
|
|
197
200
|
}
|
|
198
201
|
},
|
|
199
202
|
"additionalProperties": false,
|
|
@@ -201,6 +204,124 @@
|
|
|
201
204
|
"type"
|
|
202
205
|
]
|
|
203
206
|
},
|
|
207
|
+
"BlurFilter": {
|
|
208
|
+
"description": "Blurs the clip. Set `value` to blur both axes equally, or set `x` and `y` to blur each axis separately.",
|
|
209
|
+
"type": "object",
|
|
210
|
+
"additionalProperties": false,
|
|
211
|
+
"properties": {
|
|
212
|
+
"type": {
|
|
213
|
+
"description": "The filter type - set to `blur`.",
|
|
214
|
+
"type": "string",
|
|
215
|
+
"enum": [
|
|
216
|
+
"blur"
|
|
217
|
+
]
|
|
218
|
+
},
|
|
219
|
+
"value": {
|
|
220
|
+
"description": "Sets the blur radius in pixels, measured on the clip before it is scaled to fit the viewport. Use a number or an array of [Tween](./#tocs_tween) objects to change it over time.",
|
|
221
|
+
"oneOf": [
|
|
222
|
+
{
|
|
223
|
+
"type": "number",
|
|
224
|
+
"description": "The blur radius in pixels from 0 to 100. 0 applies no blur (default) and 10 matches the `blur` filter preset.",
|
|
225
|
+
"minimum": 0,
|
|
226
|
+
"maximum": 100,
|
|
227
|
+
"examples": [
|
|
228
|
+
10
|
|
229
|
+
]
|
|
230
|
+
},
|
|
231
|
+
{
|
|
232
|
+
"type": "array",
|
|
233
|
+
"description": "An array of [Tween](./#tocs_tween) objects that change the blur radius over time.",
|
|
234
|
+
"items": {
|
|
235
|
+
"$ref": "#/$defs/Tween"
|
|
236
|
+
}
|
|
237
|
+
}
|
|
238
|
+
]
|
|
239
|
+
},
|
|
240
|
+
"x": {
|
|
241
|
+
"description": "Sets the horizontal blur radius in pixels, overriding `value` on that axis. When omitted, `value` is used. Use a number or an array of [Tween](./#tocs_tween) objects to change it over time.",
|
|
242
|
+
"oneOf": [
|
|
243
|
+
{
|
|
244
|
+
"type": "number",
|
|
245
|
+
"description": "The horizontal blur radius in pixels from 0 to 100.",
|
|
246
|
+
"minimum": 0,
|
|
247
|
+
"maximum": 100,
|
|
248
|
+
"examples": [
|
|
249
|
+
20
|
|
250
|
+
]
|
|
251
|
+
},
|
|
252
|
+
{
|
|
253
|
+
"type": "array",
|
|
254
|
+
"description": "An array of [Tween](./#tocs_tween) objects that change the horizontal blur radius over time.",
|
|
255
|
+
"items": {
|
|
256
|
+
"$ref": "#/$defs/Tween"
|
|
257
|
+
}
|
|
258
|
+
}
|
|
259
|
+
]
|
|
260
|
+
},
|
|
261
|
+
"y": {
|
|
262
|
+
"description": "Sets the vertical blur radius in pixels, overriding `value` on that axis. When omitted, `value` is used. Use a number or an array of [Tween](./#tocs_tween) objects to change it over time.",
|
|
263
|
+
"oneOf": [
|
|
264
|
+
{
|
|
265
|
+
"type": "number",
|
|
266
|
+
"description": "The vertical blur radius in pixels from 0 to 100.",
|
|
267
|
+
"minimum": 0,
|
|
268
|
+
"maximum": 100,
|
|
269
|
+
"examples": [
|
|
270
|
+
5
|
|
271
|
+
]
|
|
272
|
+
},
|
|
273
|
+
{
|
|
274
|
+
"type": "array",
|
|
275
|
+
"description": "An array of [Tween](./#tocs_tween) objects that change the vertical blur radius over time.",
|
|
276
|
+
"items": {
|
|
277
|
+
"$ref": "#/$defs/Tween"
|
|
278
|
+
}
|
|
279
|
+
}
|
|
280
|
+
]
|
|
281
|
+
}
|
|
282
|
+
},
|
|
283
|
+
"required": [
|
|
284
|
+
"type"
|
|
285
|
+
]
|
|
286
|
+
},
|
|
287
|
+
"BrightnessFilter": {
|
|
288
|
+
"description": "Lightens or darkens the clip.",
|
|
289
|
+
"type": "object",
|
|
290
|
+
"additionalProperties": false,
|
|
291
|
+
"properties": {
|
|
292
|
+
"type": {
|
|
293
|
+
"description": "The filter type - set to `brightness`.",
|
|
294
|
+
"type": "string",
|
|
295
|
+
"enum": [
|
|
296
|
+
"brightness"
|
|
297
|
+
]
|
|
298
|
+
},
|
|
299
|
+
"value": {
|
|
300
|
+
"description": "Sets the brightness shift of the clip. Use a number or an array of [Tween](./#tocs_tween) objects to change it over time.",
|
|
301
|
+
"oneOf": [
|
|
302
|
+
{
|
|
303
|
+
"type": "number",
|
|
304
|
+
"description": "The brightness shift from -1 to 1. Positive values lighten the clip, negative values darken it and 0 leaves it unchanged (default).",
|
|
305
|
+
"minimum": -1,
|
|
306
|
+
"maximum": 1,
|
|
307
|
+
"examples": [
|
|
308
|
+
0.2
|
|
309
|
+
]
|
|
310
|
+
},
|
|
311
|
+
{
|
|
312
|
+
"type": "array",
|
|
313
|
+
"description": "An array of [Tween](./#tocs_tween) objects that change the brightness shift over time.",
|
|
314
|
+
"items": {
|
|
315
|
+
"$ref": "#/$defs/Tween"
|
|
316
|
+
}
|
|
317
|
+
}
|
|
318
|
+
]
|
|
319
|
+
}
|
|
320
|
+
},
|
|
321
|
+
"required": [
|
|
322
|
+
"type"
|
|
323
|
+
]
|
|
324
|
+
},
|
|
204
325
|
"CaptionAsset": {
|
|
205
326
|
"deprecated": true,
|
|
206
327
|
"description": "**Notice: The CaptionAsset is deprecated, use the [RichCaptionAsset](#tocs_richcaptionasset) instead.**\n\nThe 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.",
|
|
@@ -579,6 +700,13 @@
|
|
|
579
700
|
"greyscale"
|
|
580
701
|
]
|
|
581
702
|
},
|
|
703
|
+
"filters": {
|
|
704
|
+
"description": "A list of filters to apply to the Clip, in the order they appear. Each filter has a `type` and its own properties. The same type can be used more than once and numeric properties can be animated with [Tween](./#tocs_tween) objects. If `filter` is also set, the filters in this list are applied before it.",
|
|
705
|
+
"type": "array",
|
|
706
|
+
"items": {
|
|
707
|
+
"$ref": "#/$defs/Filter"
|
|
708
|
+
}
|
|
709
|
+
},
|
|
582
710
|
"opacity": {
|
|
583
711
|
"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.",
|
|
584
712
|
"oneOf": [
|
|
@@ -619,6 +747,44 @@
|
|
|
619
747
|
],
|
|
620
748
|
"type": "object"
|
|
621
749
|
},
|
|
750
|
+
"ContrastFilter": {
|
|
751
|
+
"description": "Increases or decreases the difference between the light and dark areas of the clip.",
|
|
752
|
+
"type": "object",
|
|
753
|
+
"additionalProperties": false,
|
|
754
|
+
"properties": {
|
|
755
|
+
"type": {
|
|
756
|
+
"description": "The filter type - set to `contrast`.",
|
|
757
|
+
"type": "string",
|
|
758
|
+
"enum": [
|
|
759
|
+
"contrast"
|
|
760
|
+
]
|
|
761
|
+
},
|
|
762
|
+
"value": {
|
|
763
|
+
"description": "Sets the contrast of the clip. Use a number or an array of [Tween](./#tocs_tween) objects to change it over time.",
|
|
764
|
+
"oneOf": [
|
|
765
|
+
{
|
|
766
|
+
"type": "number",
|
|
767
|
+
"description": "The contrast multiplier from 0 to 4. 1 leaves the clip unchanged (default), higher values increase the contrast and 0 produces flat grey.",
|
|
768
|
+
"minimum": 0,
|
|
769
|
+
"maximum": 4,
|
|
770
|
+
"examples": [
|
|
771
|
+
1.5
|
|
772
|
+
]
|
|
773
|
+
},
|
|
774
|
+
{
|
|
775
|
+
"type": "array",
|
|
776
|
+
"description": "An array of [Tween](./#tocs_tween) objects that change the contrast over time.",
|
|
777
|
+
"items": {
|
|
778
|
+
"$ref": "#/$defs/Tween"
|
|
779
|
+
}
|
|
780
|
+
}
|
|
781
|
+
]
|
|
782
|
+
}
|
|
783
|
+
},
|
|
784
|
+
"required": [
|
|
785
|
+
"type"
|
|
786
|
+
]
|
|
787
|
+
},
|
|
622
788
|
"Crop": {
|
|
623
789
|
"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 screen width - i.e a left crop of 0.5 will crop half of the asset from the left, a top crop of 0.25 will crop the top by quarter of the asset.",
|
|
624
790
|
"properties": {
|
|
@@ -857,6 +1023,81 @@
|
|
|
857
1023
|
}
|
|
858
1024
|
]
|
|
859
1025
|
},
|
|
1026
|
+
"Duck": {
|
|
1027
|
+
"description": "Lowers the clip's volume while other clips play and restores it afterwards, for example to keep music under a voiceover. The volume ramps down just before each referenced clip starts and back up after it ends. Requires a numeric `volume` on the clip and cannot be combined with `speed`.",
|
|
1028
|
+
"type": "object",
|
|
1029
|
+
"properties": {
|
|
1030
|
+
"under": {
|
|
1031
|
+
"description": "The clip or clips to duck under, each referenced by its alias in the form `alias://clip-name`.",
|
|
1032
|
+
"oneOf": [
|
|
1033
|
+
{
|
|
1034
|
+
"type": "string",
|
|
1035
|
+
"pattern": "^alias://[A-Za-z0-9_-]+$",
|
|
1036
|
+
"examples": [
|
|
1037
|
+
"alias://voice"
|
|
1038
|
+
]
|
|
1039
|
+
},
|
|
1040
|
+
{
|
|
1041
|
+
"type": "array",
|
|
1042
|
+
"minItems": 1,
|
|
1043
|
+
"items": {
|
|
1044
|
+
"type": "string",
|
|
1045
|
+
"pattern": "^alias://[A-Za-z0-9_-]+$"
|
|
1046
|
+
}
|
|
1047
|
+
}
|
|
1048
|
+
]
|
|
1049
|
+
},
|
|
1050
|
+
"volume": {
|
|
1051
|
+
"description": "The volume while ducked, from 0 to 1 (defaults to 0.2). It must be lower than the clip's own volume.",
|
|
1052
|
+
"type": "number",
|
|
1053
|
+
"minimum": 0,
|
|
1054
|
+
"maximum": 1,
|
|
1055
|
+
"examples": [
|
|
1056
|
+
0.2
|
|
1057
|
+
]
|
|
1058
|
+
}
|
|
1059
|
+
},
|
|
1060
|
+
"additionalProperties": false,
|
|
1061
|
+
"required": [
|
|
1062
|
+
"under"
|
|
1063
|
+
]
|
|
1064
|
+
},
|
|
1065
|
+
"Filter": {
|
|
1066
|
+
"type": "object",
|
|
1067
|
+
"description": "A filter that adjusts the look of a Clip. Choose from one of the available filter types below. Keyframe values outside a field's range are limited to that range.",
|
|
1068
|
+
"oneOf": [
|
|
1069
|
+
{
|
|
1070
|
+
"$ref": "#/$defs/BrightnessFilter"
|
|
1071
|
+
},
|
|
1072
|
+
{
|
|
1073
|
+
"$ref": "#/$defs/ContrastFilter"
|
|
1074
|
+
},
|
|
1075
|
+
{
|
|
1076
|
+
"$ref": "#/$defs/SaturationFilter"
|
|
1077
|
+
},
|
|
1078
|
+
{
|
|
1079
|
+
"$ref": "#/$defs/HueFilter"
|
|
1080
|
+
},
|
|
1081
|
+
{
|
|
1082
|
+
"$ref": "#/$defs/GradeFilter"
|
|
1083
|
+
},
|
|
1084
|
+
{
|
|
1085
|
+
"$ref": "#/$defs/BlurFilter"
|
|
1086
|
+
},
|
|
1087
|
+
{
|
|
1088
|
+
"$ref": "#/$defs/SharpenFilter"
|
|
1089
|
+
},
|
|
1090
|
+
{
|
|
1091
|
+
"$ref": "#/$defs/PixelateFilter"
|
|
1092
|
+
},
|
|
1093
|
+
{
|
|
1094
|
+
"$ref": "#/$defs/RgbSplitFilter"
|
|
1095
|
+
},
|
|
1096
|
+
{
|
|
1097
|
+
"$ref": "#/$defs/NegativeFilter"
|
|
1098
|
+
}
|
|
1099
|
+
]
|
|
1100
|
+
},
|
|
860
1101
|
"FlipTransformation": {
|
|
861
1102
|
"description": "Flip a clip vertically or horizontally. Acts as a mirror effect of the clip along the selected plane.",
|
|
862
1103
|
"type": "object",
|
|
@@ -987,6 +1228,149 @@
|
|
|
987
1228
|
},
|
|
988
1229
|
"type": "object"
|
|
989
1230
|
},
|
|
1231
|
+
"GradeFilter": {
|
|
1232
|
+
"description": "Applies several grading adjustments at once: exposure, temperature, tint, highlights, shadows and vibrance. Every property is optional and an omitted property leaves the clip unchanged.",
|
|
1233
|
+
"type": "object",
|
|
1234
|
+
"additionalProperties": false,
|
|
1235
|
+
"properties": {
|
|
1236
|
+
"type": {
|
|
1237
|
+
"description": "The filter type - set to `grade`.",
|
|
1238
|
+
"type": "string",
|
|
1239
|
+
"enum": [
|
|
1240
|
+
"grade"
|
|
1241
|
+
]
|
|
1242
|
+
},
|
|
1243
|
+
"exposure": {
|
|
1244
|
+
"description": "Sets the exposure of the clip in stops. Use a number or an array of [Tween](./#tocs_tween) objects to change it over time.",
|
|
1245
|
+
"oneOf": [
|
|
1246
|
+
{
|
|
1247
|
+
"type": "number",
|
|
1248
|
+
"description": "The exposure change from -4 to 4 stops. Each stop doubles or halves the brightness. 0 leaves the clip unchanged (default).",
|
|
1249
|
+
"minimum": -4,
|
|
1250
|
+
"maximum": 4,
|
|
1251
|
+
"examples": [
|
|
1252
|
+
0.5
|
|
1253
|
+
]
|
|
1254
|
+
},
|
|
1255
|
+
{
|
|
1256
|
+
"type": "array",
|
|
1257
|
+
"description": "An array of [Tween](./#tocs_tween) objects that change the exposure over time.",
|
|
1258
|
+
"items": {
|
|
1259
|
+
"$ref": "#/$defs/Tween"
|
|
1260
|
+
}
|
|
1261
|
+
}
|
|
1262
|
+
]
|
|
1263
|
+
},
|
|
1264
|
+
"temperature": {
|
|
1265
|
+
"description": "Sets the white balance of the clip. Use a number or an array of [Tween](./#tocs_tween) objects to change it over time.",
|
|
1266
|
+
"oneOf": [
|
|
1267
|
+
{
|
|
1268
|
+
"type": "number",
|
|
1269
|
+
"description": "The temperature shift from -1 to 1. Positive values warm the clip, negative values cool it and 0 leaves it unchanged (default).",
|
|
1270
|
+
"minimum": -1,
|
|
1271
|
+
"maximum": 1,
|
|
1272
|
+
"examples": [
|
|
1273
|
+
0.3
|
|
1274
|
+
]
|
|
1275
|
+
},
|
|
1276
|
+
{
|
|
1277
|
+
"type": "array",
|
|
1278
|
+
"description": "An array of [Tween](./#tocs_tween) objects that change the temperature over time.",
|
|
1279
|
+
"items": {
|
|
1280
|
+
"$ref": "#/$defs/Tween"
|
|
1281
|
+
}
|
|
1282
|
+
}
|
|
1283
|
+
]
|
|
1284
|
+
},
|
|
1285
|
+
"tint": {
|
|
1286
|
+
"description": "Sets the tint of the clip between green and magenta. Use a number or an array of [Tween](./#tocs_tween) objects to change it over time.",
|
|
1287
|
+
"oneOf": [
|
|
1288
|
+
{
|
|
1289
|
+
"type": "number",
|
|
1290
|
+
"description": "The tint shift from -1 to 1. Positive values shift the clip toward magenta, negative values toward green and 0 leaves it unchanged (default).",
|
|
1291
|
+
"minimum": -1,
|
|
1292
|
+
"maximum": 1,
|
|
1293
|
+
"examples": [
|
|
1294
|
+
0.2
|
|
1295
|
+
]
|
|
1296
|
+
},
|
|
1297
|
+
{
|
|
1298
|
+
"type": "array",
|
|
1299
|
+
"description": "An array of [Tween](./#tocs_tween) objects that change the tint over time.",
|
|
1300
|
+
"items": {
|
|
1301
|
+
"$ref": "#/$defs/Tween"
|
|
1302
|
+
}
|
|
1303
|
+
}
|
|
1304
|
+
]
|
|
1305
|
+
},
|
|
1306
|
+
"highlights": {
|
|
1307
|
+
"description": "Adjusts the brightest areas of the clip. Use a number or an array of [Tween](./#tocs_tween) objects to change it over time.",
|
|
1308
|
+
"oneOf": [
|
|
1309
|
+
{
|
|
1310
|
+
"type": "number",
|
|
1311
|
+
"description": "The highlights adjustment from -1 to 1. Positive values brighten the bright areas, negative values darken them and 0 leaves the clip unchanged (default).",
|
|
1312
|
+
"minimum": -1,
|
|
1313
|
+
"maximum": 1,
|
|
1314
|
+
"examples": [
|
|
1315
|
+
-0.3
|
|
1316
|
+
]
|
|
1317
|
+
},
|
|
1318
|
+
{
|
|
1319
|
+
"type": "array",
|
|
1320
|
+
"description": "An array of [Tween](./#tocs_tween) objects that change the highlights adjustment over time.",
|
|
1321
|
+
"items": {
|
|
1322
|
+
"$ref": "#/$defs/Tween"
|
|
1323
|
+
}
|
|
1324
|
+
}
|
|
1325
|
+
]
|
|
1326
|
+
},
|
|
1327
|
+
"shadows": {
|
|
1328
|
+
"description": "Adjusts the darkest areas of the clip. Use a number or an array of [Tween](./#tocs_tween) objects to change it over time.",
|
|
1329
|
+
"oneOf": [
|
|
1330
|
+
{
|
|
1331
|
+
"type": "number",
|
|
1332
|
+
"description": "The shadows adjustment from -1 to 1. Positive values lift the dark areas, negative values deepen them and 0 leaves the clip unchanged (default).",
|
|
1333
|
+
"minimum": -1,
|
|
1334
|
+
"maximum": 1,
|
|
1335
|
+
"examples": [
|
|
1336
|
+
0.3
|
|
1337
|
+
]
|
|
1338
|
+
},
|
|
1339
|
+
{
|
|
1340
|
+
"type": "array",
|
|
1341
|
+
"description": "An array of [Tween](./#tocs_tween) objects that change the shadows adjustment over time.",
|
|
1342
|
+
"items": {
|
|
1343
|
+
"$ref": "#/$defs/Tween"
|
|
1344
|
+
}
|
|
1345
|
+
}
|
|
1346
|
+
]
|
|
1347
|
+
},
|
|
1348
|
+
"vibrance": {
|
|
1349
|
+
"description": "Adjusts the saturation of the clip, with a stronger effect on muted colors than on colors that are already vivid. Use a number or an array of [Tween](./#tocs_tween) objects to change it over time.",
|
|
1350
|
+
"oneOf": [
|
|
1351
|
+
{
|
|
1352
|
+
"type": "number",
|
|
1353
|
+
"description": "The vibrance adjustment from -1 to 1. Positive values strengthen color, mostly in muted tones, negative values mute color and 0 leaves the clip unchanged (default).",
|
|
1354
|
+
"minimum": -1,
|
|
1355
|
+
"maximum": 1,
|
|
1356
|
+
"examples": [
|
|
1357
|
+
0.3
|
|
1358
|
+
]
|
|
1359
|
+
},
|
|
1360
|
+
{
|
|
1361
|
+
"type": "array",
|
|
1362
|
+
"description": "An array of [Tween](./#tocs_tween) objects that change the vibrance over time.",
|
|
1363
|
+
"items": {
|
|
1364
|
+
"$ref": "#/$defs/Tween"
|
|
1365
|
+
}
|
|
1366
|
+
}
|
|
1367
|
+
]
|
|
1368
|
+
}
|
|
1369
|
+
},
|
|
1370
|
+
"required": [
|
|
1371
|
+
"type"
|
|
1372
|
+
]
|
|
1373
|
+
},
|
|
990
1374
|
"Html5Asset": {
|
|
991
1375
|
"description": "The Html5Asset renders full HTML5/CSS3/JS.",
|
|
992
1376
|
"type": "object",
|
|
@@ -1097,6 +1481,42 @@
|
|
|
1097
1481
|
"html"
|
|
1098
1482
|
]
|
|
1099
1483
|
},
|
|
1484
|
+
"HueFilter": {
|
|
1485
|
+
"description": "Rotates the hues of the clip around the color wheel.",
|
|
1486
|
+
"type": "object",
|
|
1487
|
+
"additionalProperties": false,
|
|
1488
|
+
"properties": {
|
|
1489
|
+
"type": {
|
|
1490
|
+
"description": "The filter type - set to `hue`.",
|
|
1491
|
+
"type": "string",
|
|
1492
|
+
"enum": [
|
|
1493
|
+
"hue"
|
|
1494
|
+
]
|
|
1495
|
+
},
|
|
1496
|
+
"value": {
|
|
1497
|
+
"description": "Sets the hue rotation of the clip in degrees. Use a number or an array of [Tween](./#tocs_tween) objects to change it over time.",
|
|
1498
|
+
"oneOf": [
|
|
1499
|
+
{
|
|
1500
|
+
"type": "number",
|
|
1501
|
+
"description": "The rotation in degrees. 0 leaves the clip unchanged (default) and 360 is a full turn back to the original hues.",
|
|
1502
|
+
"examples": [
|
|
1503
|
+
90
|
|
1504
|
+
]
|
|
1505
|
+
},
|
|
1506
|
+
{
|
|
1507
|
+
"type": "array",
|
|
1508
|
+
"description": "An array of [Tween](./#tocs_tween) objects that change the hue rotation over time.",
|
|
1509
|
+
"items": {
|
|
1510
|
+
"$ref": "#/$defs/Tween"
|
|
1511
|
+
}
|
|
1512
|
+
}
|
|
1513
|
+
]
|
|
1514
|
+
}
|
|
1515
|
+
},
|
|
1516
|
+
"required": [
|
|
1517
|
+
"type"
|
|
1518
|
+
]
|
|
1519
|
+
},
|
|
1100
1520
|
"ImageAsset": {
|
|
1101
1521
|
"description": "The ImageAsset adds an image to a Clip. The image can be sourced from a URL\n(`src`), generated from a text prompt (`prompt`), or both. At least one of\n`src` or `prompt` must be provided.\n\n- **Source URL:** set `src` to the publicly accessible URL of a jpg or png file.\n- **Generated:** set `prompt` to describe the image. Choose a generator with\n `model` and configure it with model-specific `options`; the engine fills\n `src` in automatically.\n- **Both:** `src` acts as a preview placeholder while `prompt` drives\n generation — the image is regenerated from the prompt at render time.\n Unchanged prompts and options resolve from the generation cache.",
|
|
1102
1522
|
"type": "object",
|
|
@@ -1317,6 +1737,23 @@
|
|
|
1317
1737
|
},
|
|
1318
1738
|
"type": "object"
|
|
1319
1739
|
},
|
|
1740
|
+
"NegativeFilter": {
|
|
1741
|
+
"description": "Inverts the clip, turning light areas dark and dark areas light. It has no properties other than `type` and cannot be animated.",
|
|
1742
|
+
"type": "object",
|
|
1743
|
+
"additionalProperties": false,
|
|
1744
|
+
"properties": {
|
|
1745
|
+
"type": {
|
|
1746
|
+
"description": "The filter type - set to `negative`.",
|
|
1747
|
+
"type": "string",
|
|
1748
|
+
"enum": [
|
|
1749
|
+
"negative"
|
|
1750
|
+
]
|
|
1751
|
+
}
|
|
1752
|
+
},
|
|
1753
|
+
"required": [
|
|
1754
|
+
"type"
|
|
1755
|
+
]
|
|
1756
|
+
},
|
|
1320
1757
|
"Offset": {
|
|
1321
1758
|
"description": "Offsets the position of an asset horizontally or vertically by a relative distance.",
|
|
1322
1759
|
"properties": {
|
|
@@ -1501,6 +1938,44 @@
|
|
|
1501
1938
|
],
|
|
1502
1939
|
"type": "object"
|
|
1503
1940
|
},
|
|
1941
|
+
"PixelateFilter": {
|
|
1942
|
+
"description": "Turns the clip into blocky pixels.",
|
|
1943
|
+
"type": "object",
|
|
1944
|
+
"additionalProperties": false,
|
|
1945
|
+
"properties": {
|
|
1946
|
+
"type": {
|
|
1947
|
+
"description": "The filter type - set to `pixelate`.",
|
|
1948
|
+
"type": "string",
|
|
1949
|
+
"enum": [
|
|
1950
|
+
"pixelate"
|
|
1951
|
+
]
|
|
1952
|
+
},
|
|
1953
|
+
"value": {
|
|
1954
|
+
"description": "Sets the strength of the pixelation. Use a number or an array of [Tween](./#tocs_tween) objects to change it over time.",
|
|
1955
|
+
"oneOf": [
|
|
1956
|
+
{
|
|
1957
|
+
"type": "number",
|
|
1958
|
+
"description": "The pixelation strength from 0 to 1. 0 leaves the clip unchanged (default).",
|
|
1959
|
+
"minimum": 0,
|
|
1960
|
+
"maximum": 1,
|
|
1961
|
+
"examples": [
|
|
1962
|
+
0.5
|
|
1963
|
+
]
|
|
1964
|
+
},
|
|
1965
|
+
{
|
|
1966
|
+
"type": "array",
|
|
1967
|
+
"description": "An array of [Tween](./#tocs_tween) objects that change the pixelation strength over time.",
|
|
1968
|
+
"items": {
|
|
1969
|
+
"$ref": "#/$defs/Tween"
|
|
1970
|
+
}
|
|
1971
|
+
}
|
|
1972
|
+
]
|
|
1973
|
+
}
|
|
1974
|
+
},
|
|
1975
|
+
"required": [
|
|
1976
|
+
"type"
|
|
1977
|
+
]
|
|
1978
|
+
},
|
|
1504
1979
|
"Poster": {
|
|
1505
1980
|
"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.",
|
|
1506
1981
|
"properties": {
|
|
@@ -1541,6 +2016,65 @@
|
|
|
1541
2016
|
"additionalProperties": false,
|
|
1542
2017
|
"type": "object"
|
|
1543
2018
|
},
|
|
2019
|
+
"RgbSplitFilter": {
|
|
2020
|
+
"description": "Offsets the red and blue channels in opposite directions to create a color fringing effect.",
|
|
2021
|
+
"type": "object",
|
|
2022
|
+
"additionalProperties": false,
|
|
2023
|
+
"properties": {
|
|
2024
|
+
"type": {
|
|
2025
|
+
"description": "The filter type - set to `rgbSplit`.",
|
|
2026
|
+
"type": "string",
|
|
2027
|
+
"enum": [
|
|
2028
|
+
"rgbSplit"
|
|
2029
|
+
]
|
|
2030
|
+
},
|
|
2031
|
+
"x": {
|
|
2032
|
+
"description": "Sets the horizontal offset of the red and blue channels as a fraction of the clip's frame. Use a number or an array of [Tween](./#tocs_tween) objects to change it over time.",
|
|
2033
|
+
"oneOf": [
|
|
2034
|
+
{
|
|
2035
|
+
"type": "number",
|
|
2036
|
+
"description": "The horizontal offset from -1 to 1. Red moves right by this fraction and blue moves left by the same amount. Negative values reverse the direction and 0 applies no offset (default).",
|
|
2037
|
+
"minimum": -1,
|
|
2038
|
+
"maximum": 1,
|
|
2039
|
+
"examples": [
|
|
2040
|
+
0.02
|
|
2041
|
+
]
|
|
2042
|
+
},
|
|
2043
|
+
{
|
|
2044
|
+
"type": "array",
|
|
2045
|
+
"description": "An array of [Tween](./#tocs_tween) objects that change the horizontal offset over time.",
|
|
2046
|
+
"items": {
|
|
2047
|
+
"$ref": "#/$defs/Tween"
|
|
2048
|
+
}
|
|
2049
|
+
}
|
|
2050
|
+
]
|
|
2051
|
+
},
|
|
2052
|
+
"y": {
|
|
2053
|
+
"description": "Sets the vertical offset of the red and blue channels as a fraction of the clip's frame. Use a number or an array of [Tween](./#tocs_tween) objects to change it over time.",
|
|
2054
|
+
"oneOf": [
|
|
2055
|
+
{
|
|
2056
|
+
"type": "number",
|
|
2057
|
+
"description": "The vertical offset from -1 to 1. Red moves up by this fraction and blue moves down by the same amount. Negative values reverse the direction and 0 applies no offset (default).",
|
|
2058
|
+
"minimum": -1,
|
|
2059
|
+
"maximum": 1,
|
|
2060
|
+
"examples": [
|
|
2061
|
+
0.02
|
|
2062
|
+
]
|
|
2063
|
+
},
|
|
2064
|
+
{
|
|
2065
|
+
"type": "array",
|
|
2066
|
+
"description": "An array of [Tween](./#tocs_tween) objects that change the vertical offset over time.",
|
|
2067
|
+
"items": {
|
|
2068
|
+
"$ref": "#/$defs/Tween"
|
|
2069
|
+
}
|
|
2070
|
+
}
|
|
2071
|
+
]
|
|
2072
|
+
}
|
|
2073
|
+
},
|
|
2074
|
+
"required": [
|
|
2075
|
+
"type"
|
|
2076
|
+
]
|
|
2077
|
+
},
|
|
1544
2078
|
"RichCaptionActive": {
|
|
1545
2079
|
"description": "Styling properties for the active/highlighted word.",
|
|
1546
2080
|
"type": "object",
|
|
@@ -2577,6 +3111,44 @@
|
|
|
2577
3111
|
],
|
|
2578
3112
|
"type": "object"
|
|
2579
3113
|
},
|
|
3114
|
+
"SaturationFilter": {
|
|
3115
|
+
"description": "Increases or decreases the intensity of the colors in the clip.",
|
|
3116
|
+
"type": "object",
|
|
3117
|
+
"additionalProperties": false,
|
|
3118
|
+
"properties": {
|
|
3119
|
+
"type": {
|
|
3120
|
+
"description": "The filter type - set to `saturation`.",
|
|
3121
|
+
"type": "string",
|
|
3122
|
+
"enum": [
|
|
3123
|
+
"saturation"
|
|
3124
|
+
]
|
|
3125
|
+
},
|
|
3126
|
+
"value": {
|
|
3127
|
+
"description": "Sets the saturation of the clip. Use a number or an array of [Tween](./#tocs_tween) objects to change it over time.",
|
|
3128
|
+
"oneOf": [
|
|
3129
|
+
{
|
|
3130
|
+
"type": "number",
|
|
3131
|
+
"description": "The saturation multiplier from 0 to 4. 1 leaves the clip unchanged (default), higher values make colors more vivid and 0 produces greyscale.",
|
|
3132
|
+
"minimum": 0,
|
|
3133
|
+
"maximum": 4,
|
|
3134
|
+
"examples": [
|
|
3135
|
+
1.5
|
|
3136
|
+
]
|
|
3137
|
+
},
|
|
3138
|
+
{
|
|
3139
|
+
"type": "array",
|
|
3140
|
+
"description": "An array of [Tween](./#tocs_tween) objects that change the saturation over time.",
|
|
3141
|
+
"items": {
|
|
3142
|
+
"$ref": "#/$defs/Tween"
|
|
3143
|
+
}
|
|
3144
|
+
}
|
|
3145
|
+
]
|
|
3146
|
+
}
|
|
3147
|
+
},
|
|
3148
|
+
"required": [
|
|
3149
|
+
"type"
|
|
3150
|
+
]
|
|
3151
|
+
},
|
|
2580
3152
|
"ShapeAsset": {
|
|
2581
3153
|
"description": "The ShapeAsset is used to add shapes to a video. The shape can be styled with a fill and a stroke.\nYou can manipulate properties such as rotation to create dynamic effects like a diamond shape or stripes.",
|
|
2582
3154
|
"type": "object",
|
|
@@ -2735,6 +3307,65 @@
|
|
|
2735
3307
|
"shape"
|
|
2736
3308
|
]
|
|
2737
3309
|
},
|
|
3310
|
+
"SharpenFilter": {
|
|
3311
|
+
"description": "Sharpens the clip.",
|
|
3312
|
+
"type": "object",
|
|
3313
|
+
"additionalProperties": false,
|
|
3314
|
+
"properties": {
|
|
3315
|
+
"type": {
|
|
3316
|
+
"description": "The filter type - set to `sharpen`.",
|
|
3317
|
+
"type": "string",
|
|
3318
|
+
"enum": [
|
|
3319
|
+
"sharpen"
|
|
3320
|
+
]
|
|
3321
|
+
},
|
|
3322
|
+
"value": {
|
|
3323
|
+
"description": "Sets the amount of sharpening. Use a number or an array of [Tween](./#tocs_tween) objects to change it over time.",
|
|
3324
|
+
"oneOf": [
|
|
3325
|
+
{
|
|
3326
|
+
"type": "number",
|
|
3327
|
+
"description": "The sharpening amount from 0 to 40. 0 applies no sharpening (default).",
|
|
3328
|
+
"minimum": 0,
|
|
3329
|
+
"maximum": 40,
|
|
3330
|
+
"examples": [
|
|
3331
|
+
5
|
|
3332
|
+
]
|
|
3333
|
+
},
|
|
3334
|
+
{
|
|
3335
|
+
"type": "array",
|
|
3336
|
+
"description": "An array of [Tween](./#tocs_tween) objects that change the sharpening amount over time.",
|
|
3337
|
+
"items": {
|
|
3338
|
+
"$ref": "#/$defs/Tween"
|
|
3339
|
+
}
|
|
3340
|
+
}
|
|
3341
|
+
]
|
|
3342
|
+
},
|
|
3343
|
+
"radius": {
|
|
3344
|
+
"description": "Sets the sharpening radius in pixels for a 720p frame. It scales with the frame height. Use a number or an array of [Tween](./#tocs_tween) objects to change it over time.",
|
|
3345
|
+
"oneOf": [
|
|
3346
|
+
{
|
|
3347
|
+
"type": "number",
|
|
3348
|
+
"description": "The sharpening radius from 0 to 10. Defaults to 3.",
|
|
3349
|
+
"minimum": 0,
|
|
3350
|
+
"maximum": 10,
|
|
3351
|
+
"examples": [
|
|
3352
|
+
3
|
|
3353
|
+
]
|
|
3354
|
+
},
|
|
3355
|
+
{
|
|
3356
|
+
"type": "array",
|
|
3357
|
+
"description": "An array of [Tween](./#tocs_tween) objects that change the sharpening radius over time.",
|
|
3358
|
+
"items": {
|
|
3359
|
+
"$ref": "#/$defs/Tween"
|
|
3360
|
+
}
|
|
3361
|
+
}
|
|
3362
|
+
]
|
|
3363
|
+
}
|
|
3364
|
+
},
|
|
3365
|
+
"required": [
|
|
3366
|
+
"type"
|
|
3367
|
+
]
|
|
3368
|
+
},
|
|
2738
3369
|
"ShotstackDestination": {
|
|
2739
3370
|
"description": "Send videos and assets to the [Shotstack hosting and CDN](https://shotstack.io/docs/guide/serving-assets/destinations/shotstack/) service. This destination is enabled by default.",
|
|
2740
3371
|
"properties": {
|