@shotstack/schemas 1.12.1 → 1.13.0

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.
@@ -422,7 +422,44 @@
422
422
  "type": "string"
423
423
  },
424
424
  "src": {
425
- "type": "string"
425
+ "anyOf": [
426
+ {
427
+ "type": "string"
428
+ },
429
+ {
430
+ "type": "null"
431
+ }
432
+ ]
433
+ },
434
+ "prompt": {
435
+ "anyOf": [
436
+ {
437
+ "type": "string"
438
+ },
439
+ {
440
+ "type": "null"
441
+ }
442
+ ]
443
+ },
444
+ "seed": {
445
+ "anyOf": [
446
+ {
447
+ "type": "string"
448
+ },
449
+ {
450
+ "type": "null"
451
+ }
452
+ ]
453
+ },
454
+ "model": {
455
+ "anyOf": [
456
+ {
457
+ "type": "string"
458
+ },
459
+ {
460
+ "type": "null"
461
+ }
462
+ ]
426
463
  },
427
464
  "transcode": {
428
465
  "anyOf": [
@@ -515,6 +552,9 @@
515
552
  "required": [
516
553
  "type",
517
554
  "src",
555
+ "prompt",
556
+ "seed",
557
+ "model",
518
558
  "transcode",
519
559
  "trim",
520
560
  "volume",
@@ -741,7 +781,34 @@
741
781
  "type": "string"
742
782
  },
743
783
  "src": {
744
- "type": "string"
784
+ "anyOf": [
785
+ {
786
+ "type": "string"
787
+ },
788
+ {
789
+ "type": "null"
790
+ }
791
+ ]
792
+ },
793
+ "prompt": {
794
+ "anyOf": [
795
+ {
796
+ "type": "string"
797
+ },
798
+ {
799
+ "type": "null"
800
+ }
801
+ ]
802
+ },
803
+ "model": {
804
+ "anyOf": [
805
+ {
806
+ "type": "string"
807
+ },
808
+ {
809
+ "type": "null"
810
+ }
811
+ ]
745
812
  },
746
813
  "crop": {
747
814
  "anyOf": [
@@ -758,6 +825,8 @@
758
825
  "required": [
759
826
  "type",
760
827
  "src",
828
+ "prompt",
829
+ "model",
761
830
  "crop"
762
831
  ]
763
832
  },
@@ -1387,6 +1456,18 @@
1387
1456
  "type": "null"
1388
1457
  }
1389
1458
  ]
1459
+ },
1460
+ "padding": {
1461
+ "anyOf": [
1462
+ {
1463
+ "type": "integer",
1464
+ "minimum": 0,
1465
+ "maximum": 200
1466
+ },
1467
+ {
1468
+ "type": "null"
1469
+ }
1470
+ ]
1390
1471
  }
1391
1472
  },
1392
1473
  "additionalProperties": false,
@@ -1395,7 +1476,8 @@
1395
1476
  "color",
1396
1477
  "opacity",
1397
1478
  "borderRadius",
1398
- "wrap"
1479
+ "wrap",
1480
+ "padding"
1399
1481
  ]
1400
1482
  },
1401
1483
  "RichTextAlignment": {
@@ -1513,7 +1595,64 @@
1513
1595
  "type": "string"
1514
1596
  },
1515
1597
  "src": {
1516
- "type": "string"
1598
+ "anyOf": [
1599
+ {
1600
+ "type": "string"
1601
+ },
1602
+ {
1603
+ "type": "null"
1604
+ }
1605
+ ]
1606
+ },
1607
+ "prompt": {
1608
+ "anyOf": [
1609
+ {
1610
+ "type": "string"
1611
+ },
1612
+ {
1613
+ "type": "null"
1614
+ }
1615
+ ]
1616
+ },
1617
+ "voice": {
1618
+ "anyOf": [
1619
+ {
1620
+ "type": "string"
1621
+ },
1622
+ {
1623
+ "type": "null"
1624
+ }
1625
+ ]
1626
+ },
1627
+ "language": {
1628
+ "anyOf": [
1629
+ {
1630
+ "type": "string"
1631
+ },
1632
+ {
1633
+ "type": "null"
1634
+ }
1635
+ ]
1636
+ },
1637
+ "newscaster": {
1638
+ "anyOf": [
1639
+ {
1640
+ "type": "boolean"
1641
+ },
1642
+ {
1643
+ "type": "null"
1644
+ }
1645
+ ]
1646
+ },
1647
+ "model": {
1648
+ "anyOf": [
1649
+ {
1650
+ "type": "string"
1651
+ },
1652
+ {
1653
+ "type": "null"
1654
+ }
1655
+ ]
1517
1656
  },
1518
1657
  "trim": {
1519
1658
  "anyOf": [
@@ -1576,6 +1715,11 @@
1576
1715
  "required": [
1577
1716
  "type",
1578
1717
  "src",
1718
+ "prompt",
1719
+ "voice",
1720
+ "language",
1721
+ "newscaster",
1722
+ "model",
1579
1723
  "trim",
1580
1724
  "volume",
1581
1725
  "speed",
@@ -309,7 +309,44 @@
309
309
  "type": "string"
310
310
  },
311
311
  "src": {
312
- "type": "string"
312
+ "anyOf": [
313
+ {
314
+ "type": "string"
315
+ },
316
+ {
317
+ "type": "null"
318
+ }
319
+ ]
320
+ },
321
+ "prompt": {
322
+ "anyOf": [
323
+ {
324
+ "type": "string"
325
+ },
326
+ {
327
+ "type": "null"
328
+ }
329
+ ]
330
+ },
331
+ "seed": {
332
+ "anyOf": [
333
+ {
334
+ "type": "string"
335
+ },
336
+ {
337
+ "type": "null"
338
+ }
339
+ ]
340
+ },
341
+ "model": {
342
+ "anyOf": [
343
+ {
344
+ "type": "string"
345
+ },
346
+ {
347
+ "type": "null"
348
+ }
349
+ ]
313
350
  },
314
351
  "transcode": {
315
352
  "anyOf": [
@@ -402,6 +439,9 @@
402
439
  "required": [
403
440
  "type",
404
441
  "src",
442
+ "prompt",
443
+ "seed",
444
+ "model",
405
445
  "transcode",
406
446
  "trim",
407
447
  "volume",
@@ -628,7 +668,34 @@
628
668
  "type": "string"
629
669
  },
630
670
  "src": {
631
- "type": "string"
671
+ "anyOf": [
672
+ {
673
+ "type": "string"
674
+ },
675
+ {
676
+ "type": "null"
677
+ }
678
+ ]
679
+ },
680
+ "prompt": {
681
+ "anyOf": [
682
+ {
683
+ "type": "string"
684
+ },
685
+ {
686
+ "type": "null"
687
+ }
688
+ ]
689
+ },
690
+ "model": {
691
+ "anyOf": [
692
+ {
693
+ "type": "string"
694
+ },
695
+ {
696
+ "type": "null"
697
+ }
698
+ ]
632
699
  },
633
700
  "crop": {
634
701
  "anyOf": [
@@ -645,6 +712,8 @@
645
712
  "required": [
646
713
  "type",
647
714
  "src",
715
+ "prompt",
716
+ "model",
648
717
  "crop"
649
718
  ]
650
719
  },
@@ -1274,6 +1343,18 @@
1274
1343
  "type": "null"
1275
1344
  }
1276
1345
  ]
1346
+ },
1347
+ "padding": {
1348
+ "anyOf": [
1349
+ {
1350
+ "type": "integer",
1351
+ "minimum": 0,
1352
+ "maximum": 200
1353
+ },
1354
+ {
1355
+ "type": "null"
1356
+ }
1357
+ ]
1277
1358
  }
1278
1359
  },
1279
1360
  "additionalProperties": false,
@@ -1282,7 +1363,8 @@
1282
1363
  "color",
1283
1364
  "opacity",
1284
1365
  "borderRadius",
1285
- "wrap"
1366
+ "wrap",
1367
+ "padding"
1286
1368
  ]
1287
1369
  },
1288
1370
  "RichTextAlignment": {
@@ -1400,7 +1482,64 @@
1400
1482
  "type": "string"
1401
1483
  },
1402
1484
  "src": {
1403
- "type": "string"
1485
+ "anyOf": [
1486
+ {
1487
+ "type": "string"
1488
+ },
1489
+ {
1490
+ "type": "null"
1491
+ }
1492
+ ]
1493
+ },
1494
+ "prompt": {
1495
+ "anyOf": [
1496
+ {
1497
+ "type": "string"
1498
+ },
1499
+ {
1500
+ "type": "null"
1501
+ }
1502
+ ]
1503
+ },
1504
+ "voice": {
1505
+ "anyOf": [
1506
+ {
1507
+ "type": "string"
1508
+ },
1509
+ {
1510
+ "type": "null"
1511
+ }
1512
+ ]
1513
+ },
1514
+ "language": {
1515
+ "anyOf": [
1516
+ {
1517
+ "type": "string"
1518
+ },
1519
+ {
1520
+ "type": "null"
1521
+ }
1522
+ ]
1523
+ },
1524
+ "newscaster": {
1525
+ "anyOf": [
1526
+ {
1527
+ "type": "boolean"
1528
+ },
1529
+ {
1530
+ "type": "null"
1531
+ }
1532
+ ]
1533
+ },
1534
+ "model": {
1535
+ "anyOf": [
1536
+ {
1537
+ "type": "string"
1538
+ },
1539
+ {
1540
+ "type": "null"
1541
+ }
1542
+ ]
1404
1543
  },
1405
1544
  "trim": {
1406
1545
  "anyOf": [
@@ -1463,6 +1602,11 @@
1463
1602
  "required": [
1464
1603
  "type",
1465
1604
  "src",
1605
+ "prompt",
1606
+ "voice",
1607
+ "language",
1608
+ "newscaster",
1609
+ "model",
1466
1610
  "trim",
1467
1611
  "volume",
1468
1612
  "speed",
@@ -2,25 +2,65 @@
2
2
  "name": "VideoAsset",
3
3
  "strict": true,
4
4
  "schema": {
5
- "description": "The VideoAsset is used to create video sequences from video files. The ...",
5
+ "description": "The VideoAsset adds a video to a Clip. The video can be sourced from a URL\n(`src`) or generated from a text prompt (`prompt`), optionally seeded from a\nstarting image (`seed`). Exactly one of...",
6
6
  "type": "object",
7
7
  "properties": {
8
8
  "type": {
9
9
  "enum": [
10
10
  "video"
11
11
  ],
12
- "description": "The type of asset -...",
12
+ "description": "The type of a...",
13
13
  "type": "string"
14
14
  },
15
15
  "src": {
16
- "description": "The video source URL. The URL must be...",
17
- "type": "string"
16
+ "anyOf": [
17
+ {
18
+ "type": "string",
19
+ "description": "The video source URL. The URL must be pu..."
20
+ },
21
+ {
22
+ "type": "null"
23
+ }
24
+ ]
25
+ },
26
+ "prompt": {
27
+ "anyOf": [
28
+ {
29
+ "type": "string",
30
+ "description": "A text prompt to generate the video from. When set without `src`, the ..."
31
+ },
32
+ {
33
+ "type": "null"
34
+ }
35
+ ]
36
+ },
37
+ "seed": {
38
+ "anyOf": [
39
+ {
40
+ "type": "string",
41
+ "description": "Seed image URL for image-to-video generation. The i..."
42
+ },
43
+ {
44
+ "type": "null"
45
+ }
46
+ ]
47
+ },
48
+ "model": {
49
+ "anyOf": [
50
+ {
51
+ "type": "string",
52
+ "description": "The generation model to use when `prompt` is set..."
53
+ },
54
+ {
55
+ "type": "null"
56
+ }
57
+ ]
18
58
  },
19
59
  "transcode": {
20
60
  "anyOf": [
21
61
  {
22
62
  "type": "boolean",
23
- "description": "Set to `true` to force re-encoding of the video during preprocessing. This can help resolve compatibility issues, fix rotation ..."
63
+ "description": "Set to `true` to force re-encoding of the video during preprocessing. This can help resol..."
24
64
  },
25
65
  {
26
66
  "type": "null"
@@ -31,7 +71,7 @@
31
71
  "anyOf": [
32
72
  {
33
73
  "type": "number",
34
- "description": "The start trim point of the video clip, in seconds (defaults to 0). Videos will start ..."
74
+ "description": "The start trim point of the video clip, in seconds (defaults..."
35
75
  },
36
76
  {
37
77
  "type": "null"
@@ -39,17 +79,17 @@
39
79
  ]
40
80
  },
41
81
  "volume": {
42
- "description": "Set the volume of the video clip. Use a number or an array of...",
82
+ "description": "Set the volume of the video clip. Use a nu...",
43
83
  "anyOf": [
44
84
  {
45
85
  "type": "number",
46
- "description": "The volume level for the video clip. Range varies from...",
86
+ "description": "The volume level for the video clip. ...",
47
87
  "minimum": 0,
48
88
  "maximum": 1
49
89
  },
50
90
  {
51
91
  "type": "array",
52
- "description": "An array of [Tween](./#tocs_tween) objects used to create...",
92
+ "description": "An array of [Tween](./#tocs_tween) obje...",
53
93
  "items": {
54
94
  "$ref": "#/$defs/Tween"
55
95
  }
@@ -63,7 +103,7 @@
63
103
  "anyOf": [
64
104
  {
65
105
  "type": "string",
66
- "description": "Preset volume effects to apply to the video asset <ul>\n <li>`fadeIn` - fade volume in only</li...",
106
+ "description": "Preset volume effects to apply to the video asset <ul>\n <li>`fade...",
67
107
  "enum": [
68
108
  "none",
69
109
  "fadeIn",
@@ -80,7 +120,7 @@
80
120
  "anyOf": [
81
121
  {
82
122
  "type": "number",
83
- "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...",
123
+ "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...",
84
124
  "minimum": 0,
85
125
  "maximum": 10
86
126
  },
@@ -114,6 +154,9 @@
114
154
  "required": [
115
155
  "type",
116
156
  "src",
157
+ "prompt",
158
+ "seed",
159
+ "model",
117
160
  "transcode",
118
161
  "trim",
119
162
  "volume",
@@ -124,13 +167,13 @@
124
167
  ],
125
168
  "$defs": {
126
169
  "Tween": {
127
- "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...",
170
+ "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:...",
128
171
  "properties": {
129
172
  "from": {
130
173
  "anyOf": [
131
174
  {
132
175
  "type": "string",
133
- "description": "The initial property valu..."
176
+ "description": "The initial prope..."
134
177
  },
135
178
  {
136
179
  "type": "null"
@@ -141,7 +184,7 @@
141
184
  "anyOf": [
142
185
  {
143
186
  "type": "string",
144
- "description": "The final property valu..."
187
+ "description": "The final prope..."
145
188
  },
146
189
  {
147
190
  "type": "null"
@@ -152,7 +195,7 @@
152
195
  "anyOf": [
153
196
  {
154
197
  "type": "number",
155
- "description": "The time in seconds when the animation ..."
198
+ "description": "The time in seconds when th..."
156
199
  },
157
200
  {
158
201
  "type": "null"
@@ -163,7 +206,7 @@
163
206
  "anyOf": [
164
207
  {
165
208
  "type": "number",
166
- "description": "The duration of t..."
209
+ "description": "The duratio..."
167
210
  },
168
211
  {
169
212
  "type": "null"
@@ -174,7 +217,7 @@
174
217
  "anyOf": [
175
218
  {
176
219
  "type": "string",
177
- "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 ...",
220
+ "description": "The interpolation method to use for the animation. Available options are: <ul>\n <li>`linear` - a linear interpolation between the st...",
178
221
  "enum": [
179
222
  "linear",
180
223
  "bezier",
@@ -190,7 +233,7 @@
190
233
  "anyOf": [
191
234
  {
192
235
  "type": "string",
193
- "description": "The easing function to use for the animation. Easing controls the rate of change of the animated value, allowing for more na...",
236
+ "description": "The easing function to use for the animation. Easing controls the rate of change of th...",
194
237
  "enum": [
195
238
  "ease",
196
239
  "easeIn",
@@ -240,13 +283,13 @@
240
283
  ]
241
284
  },
242
285
  "Crop": {
243
- "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...",
286
+ "description": "Crop the sides of an asset by a relative amount. The size of the crop is specified using a s...",
244
287
  "properties": {
245
288
  "top": {
246
289
  "anyOf": [
247
290
  {
248
291
  "type": "number",
249
- "description": "Crop from t...",
292
+ "description": "Crop fr...",
250
293
  "minimum": 0,
251
294
  "maximum": 1
252
295
  },
@@ -259,7 +302,7 @@
259
302
  "anyOf": [
260
303
  {
261
304
  "type": "number",
262
- "description": "Crop from the...",
305
+ "description": "Crop fro...",
263
306
  "minimum": 0,
264
307
  "maximum": 1
265
308
  },
@@ -272,7 +315,7 @@
272
315
  "anyOf": [
273
316
  {
274
317
  "type": "number",
275
- "description": "Crop from th...",
318
+ "description": "Crop fr...",
276
319
  "minimum": 0,
277
320
  "maximum": 1
278
321
  },
@@ -285,7 +328,7 @@
285
328
  "anyOf": [
286
329
  {
287
330
  "type": "number",
288
- "description": "Crop from th...",
331
+ "description": "Crop fr...",
289
332
  "minimum": 0,
290
333
  "maximum": 1
291
334
  },
@@ -305,17 +348,17 @@
305
348
  ]
306
349
  },
307
350
  "ChromaKey": {
308
- "description": "Chroma key is a technique that replaces a specific color in a video with a different background image or vi...",
351
+ "description": "Chroma key is a technique that replaces a specific color in a video with a ...",
309
352
  "properties": {
310
353
  "color": {
311
- "description": "The chroma key color as a hex value. Use green (#00b140) for green screens o...",
354
+ "description": "The chroma key color as a hex value. Use green (#00b1...",
312
355
  "type": "string"
313
356
  },
314
357
  "threshold": {
315
358
  "anyOf": [
316
359
  {
317
360
  "type": "integer",
318
- "description": "Pixels within this distance from the key color...",
361
+ "description": "Pixels within this distance from...",
319
362
  "minimum": 0,
320
363
  "maximum": 250
321
364
  },
@@ -328,7 +371,7 @@
328
371
  "anyOf": [
329
372
  {
330
373
  "type": "integer",
331
- "description": "Pixels within the halo distance from the threshold boundary are gi...",
374
+ "description": "Pixels within the halo distance from the thre...",
332
375
  "minimum": 0,
333
376
  "maximum": 250
334
377
  },