@shotstack/schemas 1.12.2 → 1.13.1
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 +73 -19
- package/dist/json-schema/asset.json +134 -3
- package/dist/json-schema/audio-asset.json +84 -17
- package/dist/json-schema/clip.json +134 -3
- package/dist/json-schema/edit.json +134 -3
- package/dist/json-schema/image-asset.json +34 -3
- package/dist/json-schema/image-to-video-asset.json +1 -1
- package/dist/json-schema/schemas.json +157 -16
- package/dist/json-schema/template.json +135 -4
- package/dist/json-schema/text-to-image-asset.json +1 -1
- package/dist/json-schema/text-to-speech-asset.json +19 -19
- package/dist/json-schema/timeline.json +134 -3
- package/dist/json-schema/track.json +134 -3
- package/dist/json-schema/video-asset.json +70 -27
- package/dist/schema.d.ts +120 -16
- package/dist/zod/zod.gen.cjs +114 -12
- package/dist/zod/zod.gen.d.ts +1835 -1094
- package/dist/zod/zod.gen.js +114 -12
- package/dist/zod/zod.gen.ts +114 -12
- package/package.json +1 -1
|
@@ -450,7 +450,7 @@
|
|
|
450
450
|
]
|
|
451
451
|
},
|
|
452
452
|
"VideoAsset": {
|
|
453
|
-
"description": "The VideoAsset
|
|
453
|
+
"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 `src` or `prompt` must be provided.\n\n- **Source URL:** set `src` to the URL of an mp4 (or compatible) video file.\n- **Generated:** set `prompt` to describe the motion. Optionally set `seed` to\n a starting image URL (image-to-video). Use `model` to choose the generator\n (e.g. `luma-ray-3`, `runpod-itv-mini`). The generated `src` is filled in\n automatically.\n",
|
|
454
454
|
"type": "object",
|
|
455
455
|
"properties": {
|
|
456
456
|
"type": {
|
|
@@ -461,8 +461,48 @@
|
|
|
461
461
|
"type": "string"
|
|
462
462
|
},
|
|
463
463
|
"src": {
|
|
464
|
-
"
|
|
465
|
-
|
|
464
|
+
"anyOf": [
|
|
465
|
+
{
|
|
466
|
+
"type": "string",
|
|
467
|
+
"description": "The video source URL. The URL must be publicly accessible or include credentials. Provide either `src` or `prompt`, not both."
|
|
468
|
+
},
|
|
469
|
+
{
|
|
470
|
+
"type": "null"
|
|
471
|
+
}
|
|
472
|
+
]
|
|
473
|
+
},
|
|
474
|
+
"prompt": {
|
|
475
|
+
"anyOf": [
|
|
476
|
+
{
|
|
477
|
+
"type": "string",
|
|
478
|
+
"description": "A text prompt to generate the video from. When set without `src`, the engine generates a video and fills `src` automatically. Optionally pair with `seed` for image-to-video. Use `model` to choose the generator."
|
|
479
|
+
},
|
|
480
|
+
{
|
|
481
|
+
"type": "null"
|
|
482
|
+
}
|
|
483
|
+
]
|
|
484
|
+
},
|
|
485
|
+
"seed": {
|
|
486
|
+
"anyOf": [
|
|
487
|
+
{
|
|
488
|
+
"type": "string",
|
|
489
|
+
"description": "Seed image URL for image-to-video generation. The image is used as the starting frame; `prompt` describes the motion. Has no effect unless `prompt` is set."
|
|
490
|
+
},
|
|
491
|
+
{
|
|
492
|
+
"type": "null"
|
|
493
|
+
}
|
|
494
|
+
]
|
|
495
|
+
},
|
|
496
|
+
"model": {
|
|
497
|
+
"anyOf": [
|
|
498
|
+
{
|
|
499
|
+
"type": "string",
|
|
500
|
+
"description": "The generation model to use when `prompt` is set (e.g. `luma-ray-3`, `runpod-itv-mini`). Defaults to the platform's preferred generator if omitted."
|
|
501
|
+
},
|
|
502
|
+
{
|
|
503
|
+
"type": "null"
|
|
504
|
+
}
|
|
505
|
+
]
|
|
466
506
|
},
|
|
467
507
|
"transcode": {
|
|
468
508
|
"anyOf": [
|
|
@@ -528,7 +568,7 @@
|
|
|
528
568
|
"anyOf": [
|
|
529
569
|
{
|
|
530
570
|
"type": "number",
|
|
531
|
-
"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
|
|
571
|
+
"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 length. For example, if you set speed to 0.5, the clip will need to be 2x as long to play the entire video (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 video (i.e. original length / 2).",
|
|
532
572
|
"minimum": 0,
|
|
533
573
|
"maximum": 10
|
|
534
574
|
},
|
|
@@ -562,6 +602,9 @@
|
|
|
562
602
|
"required": [
|
|
563
603
|
"type",
|
|
564
604
|
"src",
|
|
605
|
+
"prompt",
|
|
606
|
+
"seed",
|
|
607
|
+
"model",
|
|
565
608
|
"transcode",
|
|
566
609
|
"trim",
|
|
567
610
|
"volume",
|
|
@@ -795,7 +838,7 @@
|
|
|
795
838
|
"type": "object"
|
|
796
839
|
},
|
|
797
840
|
"ImageAsset": {
|
|
798
|
-
"description": "The ImageAsset
|
|
841
|
+
"description": "The ImageAsset adds an image to a Clip. The image can be sourced from a URL\n(`src`) or generated from a text prompt (`prompt`). Exactly one of `src` or\n`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; the engine generates it\n using the provider chosen by `model` and fills `src` in automatically.\n",
|
|
799
842
|
"type": "object",
|
|
800
843
|
"properties": {
|
|
801
844
|
"type": {
|
|
@@ -806,8 +849,37 @@
|
|
|
806
849
|
"type": "string"
|
|
807
850
|
},
|
|
808
851
|
"src": {
|
|
809
|
-
"
|
|
810
|
-
|
|
852
|
+
"anyOf": [
|
|
853
|
+
{
|
|
854
|
+
"type": "string",
|
|
855
|
+
"description": "The image source URL. The URL must be publicly accessible or include credentials. Provide either `src` or `prompt`, not both."
|
|
856
|
+
},
|
|
857
|
+
{
|
|
858
|
+
"type": "null"
|
|
859
|
+
}
|
|
860
|
+
]
|
|
861
|
+
},
|
|
862
|
+
"prompt": {
|
|
863
|
+
"anyOf": [
|
|
864
|
+
{
|
|
865
|
+
"type": "string",
|
|
866
|
+
"description": "A text prompt to generate the image from. When set without `src`, the engine generates an image and fills `src` automatically. Use `model` to choose the generator."
|
|
867
|
+
},
|
|
868
|
+
{
|
|
869
|
+
"type": "null"
|
|
870
|
+
}
|
|
871
|
+
]
|
|
872
|
+
},
|
|
873
|
+
"model": {
|
|
874
|
+
"anyOf": [
|
|
875
|
+
{
|
|
876
|
+
"type": "string",
|
|
877
|
+
"description": "The generation model to use when `prompt` is set (e.g. `flux-schnell`). Defaults to the platform's preferred generator if omitted."
|
|
878
|
+
},
|
|
879
|
+
{
|
|
880
|
+
"type": "null"
|
|
881
|
+
}
|
|
882
|
+
]
|
|
811
883
|
},
|
|
812
884
|
"crop": {
|
|
813
885
|
"anyOf": [
|
|
@@ -824,6 +896,8 @@
|
|
|
824
896
|
"required": [
|
|
825
897
|
"type",
|
|
826
898
|
"src",
|
|
899
|
+
"prompt",
|
|
900
|
+
"model",
|
|
827
901
|
"crop"
|
|
828
902
|
]
|
|
829
903
|
},
|
|
@@ -1650,7 +1724,7 @@
|
|
|
1650
1724
|
"type": "object"
|
|
1651
1725
|
},
|
|
1652
1726
|
"AudioAsset": {
|
|
1653
|
-
"description": "The AudioAsset
|
|
1727
|
+
"description": "The AudioAsset adds audio to a Clip. The audio can be sourced from a URL\n(`src`) or generated from a text prompt (`prompt`). Exactly one of `src` or\n`prompt` must be provided.\n\n- **Source URL:** set `src` to a publicly accessible audio URL (e.g. mp3).\n- **Generated speech:** set `prompt` to the spoken text and `voice` to a voice\n identifier (text-to-speech). Optionally set `language`/`newscaster`.\n- **Generated music or SFX:** set `prompt` describing the sound; omit `voice`.\n- Use `model` to choose the generator. The generated `src` is filled in\n automatically.\n",
|
|
1654
1728
|
"type": "object",
|
|
1655
1729
|
"properties": {
|
|
1656
1730
|
"type": {
|
|
@@ -1661,8 +1735,70 @@
|
|
|
1661
1735
|
"type": "string"
|
|
1662
1736
|
},
|
|
1663
1737
|
"src": {
|
|
1664
|
-
"
|
|
1665
|
-
|
|
1738
|
+
"anyOf": [
|
|
1739
|
+
{
|
|
1740
|
+
"type": "string",
|
|
1741
|
+
"description": "The audio source URL. The URL must be publicly accessible or include credentials. Provide either `src` or `prompt`, not both."
|
|
1742
|
+
},
|
|
1743
|
+
{
|
|
1744
|
+
"type": "null"
|
|
1745
|
+
}
|
|
1746
|
+
]
|
|
1747
|
+
},
|
|
1748
|
+
"prompt": {
|
|
1749
|
+
"anyOf": [
|
|
1750
|
+
{
|
|
1751
|
+
"type": "string",
|
|
1752
|
+
"description": "A text prompt. When `voice` is set, the prompt is the spoken text (text-to-speech). Without `voice`, the prompt describes generated music or sound effects. The generated `src` is filled in automatically."
|
|
1753
|
+
},
|
|
1754
|
+
{
|
|
1755
|
+
"type": "null"
|
|
1756
|
+
}
|
|
1757
|
+
]
|
|
1758
|
+
},
|
|
1759
|
+
"voice": {
|
|
1760
|
+
"anyOf": [
|
|
1761
|
+
{
|
|
1762
|
+
"type": "string",
|
|
1763
|
+
"description": "Voice identifier for text-to-speech generation (e.g. `Matthew`, `Joanna`). Only meaningful when `prompt` is set."
|
|
1764
|
+
},
|
|
1765
|
+
{
|
|
1766
|
+
"type": "null"
|
|
1767
|
+
}
|
|
1768
|
+
]
|
|
1769
|
+
},
|
|
1770
|
+
"language": {
|
|
1771
|
+
"anyOf": [
|
|
1772
|
+
{
|
|
1773
|
+
"type": "string",
|
|
1774
|
+
"description": "Optional BCP-47 language code (e.g. `en-US`) for text-to-speech. Only meaningful when `prompt` and `voice` are set."
|
|
1775
|
+
},
|
|
1776
|
+
{
|
|
1777
|
+
"type": "null"
|
|
1778
|
+
}
|
|
1779
|
+
]
|
|
1780
|
+
},
|
|
1781
|
+
"newscaster": {
|
|
1782
|
+
"anyOf": [
|
|
1783
|
+
{
|
|
1784
|
+
"type": "boolean",
|
|
1785
|
+
"description": "Set to `true` to use the voice's newscaster mode when supported. Only meaningful when `prompt` and `voice` are set."
|
|
1786
|
+
},
|
|
1787
|
+
{
|
|
1788
|
+
"type": "null"
|
|
1789
|
+
}
|
|
1790
|
+
]
|
|
1791
|
+
},
|
|
1792
|
+
"model": {
|
|
1793
|
+
"anyOf": [
|
|
1794
|
+
{
|
|
1795
|
+
"type": "string",
|
|
1796
|
+
"description": "The generation model to use when `prompt` is set (e.g. `polly-neural`). Defaults to the platform's preferred generator if omitted."
|
|
1797
|
+
},
|
|
1798
|
+
{
|
|
1799
|
+
"type": "null"
|
|
1800
|
+
}
|
|
1801
|
+
]
|
|
1666
1802
|
},
|
|
1667
1803
|
"trim": {
|
|
1668
1804
|
"anyOf": [
|
|
@@ -1700,7 +1836,7 @@
|
|
|
1700
1836
|
"anyOf": [
|
|
1701
1837
|
{
|
|
1702
1838
|
"type": "number",
|
|
1703
|
-
"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
|
|
1839
|
+
"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).",
|
|
1704
1840
|
"minimum": 0,
|
|
1705
1841
|
"maximum": 10
|
|
1706
1842
|
},
|
|
@@ -1731,6 +1867,11 @@
|
|
|
1731
1867
|
"required": [
|
|
1732
1868
|
"type",
|
|
1733
1869
|
"src",
|
|
1870
|
+
"prompt",
|
|
1871
|
+
"voice",
|
|
1872
|
+
"language",
|
|
1873
|
+
"newscaster",
|
|
1874
|
+
"model",
|
|
1734
1875
|
"trim",
|
|
1735
1876
|
"volume",
|
|
1736
1877
|
"speed",
|
|
@@ -2821,7 +2962,7 @@
|
|
|
2821
2962
|
]
|
|
2822
2963
|
},
|
|
2823
2964
|
"TextToImageAsset": {
|
|
2824
|
-
"description": "
|
|
2965
|
+
"description": "**Notice: TextToImageAsset is deprecated. Use [ImageAsset](#tocs_imageasset)\nwith `prompt` instead.** This type continues to function and is internally\nrewritten to ImageAsset; no behaviour change for existing integrations.\n\nThe TextToImageAsset lets you create a dynamic image from a text prompt.\n",
|
|
2825
2966
|
"properties": {
|
|
2826
2967
|
"type": {
|
|
2827
2968
|
"type": "string",
|
|
@@ -2878,7 +3019,7 @@
|
|
|
2878
3019
|
]
|
|
2879
3020
|
},
|
|
2880
3021
|
"ImageToVideoAsset": {
|
|
2881
|
-
"description": "
|
|
3022
|
+
"description": "**Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)\nwith `prompt` and `seed` instead.** This type continues to function and is\ninternally rewritten to VideoAsset; no behaviour change for existing\nintegrations.\n\nThe ImageToVideoAsset lets you create a video from an image and a text prompt.\n",
|
|
2882
3023
|
"properties": {
|
|
2883
3024
|
"type": {
|
|
2884
3025
|
"type": "string",
|
|
@@ -2958,7 +3099,7 @@
|
|
|
2958
3099
|
]
|
|
2959
3100
|
},
|
|
2960
3101
|
"TextToSpeechAsset": {
|
|
2961
|
-
"description": "
|
|
3102
|
+
"description": "**Notice: TextToSpeechAsset is deprecated. Use [AudioAsset](#tocs_audioasset)\nwith `prompt` (the spoken text) and `voice` instead.** This type continues to\nfunction and is internally rewritten to AudioAsset; no behaviour change for\nexisting integrations.\n\nThe TextToSpeechAsset lets you generate a voice over from text using a text-to-speech service.\nThe generated audio can be trimmed, faded and have its volume and speed adjusted using the\nsame properties available on the AudioAsset.\n",
|
|
2962
3103
|
"type": "object",
|
|
2963
3104
|
"properties": {
|
|
2964
3105
|
"type": {
|
|
@@ -3368,7 +3509,7 @@
|
|
|
3368
3509
|
]
|
|
3369
3510
|
},
|
|
3370
3511
|
"Output": {
|
|
3371
|
-
"description": "The output format, render range and type of media to generate.",
|
|
3512
|
+
"description": "The output format, render range and type of media to generate. For all formats except `mp3`, either `resolution` or `size` (with both `width` and `height`) must be specified.",
|
|
3372
3513
|
"properties": {
|
|
3373
3514
|
"format": {
|
|
3374
3515
|
"description": "The output format and type of media file to generate. <ul>\n <li>`mp4` - mp4 video file</li>\n <li>`gif` - animated gif</li>\n <li>`jpg` - jpg image file</li>\n <li>`png` - png image file</li>\n <li>`bmp` - bmp image file</li>\n <li>`mp3` - mp3 audio file (audio only)</li>\n</ul>",
|
|
@@ -3386,7 +3527,7 @@
|
|
|
3386
3527
|
"anyOf": [
|
|
3387
3528
|
{
|
|
3388
3529
|
"type": "string",
|
|
3389
|
-
"description": "The preset output resolution of the video or image. For custom sizes use the `size` property. <ul>\n <li>`preview` - 512px x 288px @ 15fps</li>\n <li>`mobile` - 640px x 360px @ 25fps</li>\n <li>`sd` - 1024px x 576px @ 25fps</li>\n <li>`hd` - 1280px x 720px @ 25fps</li>\n <li>`1080` - 1920px x 1080px @ 25fps</li>\n <li>`4k` - 3840px x 2160px @ 25fps</li>\n</ul>",
|
|
3530
|
+
"description": "The preset output resolution of the video or image. For custom sizes use the `size` property. Either `resolution` or `size` (with both `width` and `height`) must be specified for all formats except `mp3`. <ul>\n <li>`preview` - 512px x 288px @ 15fps</li>\n <li>`mobile` - 640px x 360px @ 25fps</li>\n <li>`sd` - 1024px x 576px @ 25fps</li>\n <li>`hd` - 1280px x 720px @ 25fps</li>\n <li>`1080` - 1920px x 1080px @ 25fps</li>\n <li>`4k` - 3840px x 2160px @ 25fps</li>\n</ul>",
|
|
3390
3531
|
"enum": [
|
|
3391
3532
|
"preview",
|
|
3392
3533
|
"mobile",
|
|
@@ -212,7 +212,44 @@
|
|
|
212
212
|
"type": "string"
|
|
213
213
|
},
|
|
214
214
|
"src": {
|
|
215
|
-
"
|
|
215
|
+
"anyOf": [
|
|
216
|
+
{
|
|
217
|
+
"type": "string"
|
|
218
|
+
},
|
|
219
|
+
{
|
|
220
|
+
"type": "null"
|
|
221
|
+
}
|
|
222
|
+
]
|
|
223
|
+
},
|
|
224
|
+
"prompt": {
|
|
225
|
+
"anyOf": [
|
|
226
|
+
{
|
|
227
|
+
"type": "string"
|
|
228
|
+
},
|
|
229
|
+
{
|
|
230
|
+
"type": "null"
|
|
231
|
+
}
|
|
232
|
+
]
|
|
233
|
+
},
|
|
234
|
+
"seed": {
|
|
235
|
+
"anyOf": [
|
|
236
|
+
{
|
|
237
|
+
"type": "string"
|
|
238
|
+
},
|
|
239
|
+
{
|
|
240
|
+
"type": "null"
|
|
241
|
+
}
|
|
242
|
+
]
|
|
243
|
+
},
|
|
244
|
+
"model": {
|
|
245
|
+
"anyOf": [
|
|
246
|
+
{
|
|
247
|
+
"type": "string"
|
|
248
|
+
},
|
|
249
|
+
{
|
|
250
|
+
"type": "null"
|
|
251
|
+
}
|
|
252
|
+
]
|
|
216
253
|
},
|
|
217
254
|
"trim": {
|
|
218
255
|
"anyOf": [
|
|
@@ -269,6 +306,9 @@
|
|
|
269
306
|
"required": [
|
|
270
307
|
"type",
|
|
271
308
|
"src",
|
|
309
|
+
"prompt",
|
|
310
|
+
"seed",
|
|
311
|
+
"model",
|
|
272
312
|
"trim",
|
|
273
313
|
"volume",
|
|
274
314
|
"volumeEffect",
|
|
@@ -285,13 +325,42 @@
|
|
|
285
325
|
"type": "string"
|
|
286
326
|
},
|
|
287
327
|
"src": {
|
|
288
|
-
"
|
|
328
|
+
"anyOf": [
|
|
329
|
+
{
|
|
330
|
+
"type": "string"
|
|
331
|
+
},
|
|
332
|
+
{
|
|
333
|
+
"type": "null"
|
|
334
|
+
}
|
|
335
|
+
]
|
|
336
|
+
},
|
|
337
|
+
"prompt": {
|
|
338
|
+
"anyOf": [
|
|
339
|
+
{
|
|
340
|
+
"type": "string"
|
|
341
|
+
},
|
|
342
|
+
{
|
|
343
|
+
"type": "null"
|
|
344
|
+
}
|
|
345
|
+
]
|
|
346
|
+
},
|
|
347
|
+
"model": {
|
|
348
|
+
"anyOf": [
|
|
349
|
+
{
|
|
350
|
+
"type": "string"
|
|
351
|
+
},
|
|
352
|
+
{
|
|
353
|
+
"type": "null"
|
|
354
|
+
}
|
|
355
|
+
]
|
|
289
356
|
}
|
|
290
357
|
},
|
|
291
358
|
"additionalProperties": false,
|
|
292
359
|
"required": [
|
|
293
360
|
"type",
|
|
294
|
-
"src"
|
|
361
|
+
"src",
|
|
362
|
+
"prompt",
|
|
363
|
+
"model"
|
|
295
364
|
]
|
|
296
365
|
},
|
|
297
366
|
"AudioAsset": {
|
|
@@ -304,7 +373,64 @@
|
|
|
304
373
|
"type": "string"
|
|
305
374
|
},
|
|
306
375
|
"src": {
|
|
307
|
-
"
|
|
376
|
+
"anyOf": [
|
|
377
|
+
{
|
|
378
|
+
"type": "string"
|
|
379
|
+
},
|
|
380
|
+
{
|
|
381
|
+
"type": "null"
|
|
382
|
+
}
|
|
383
|
+
]
|
|
384
|
+
},
|
|
385
|
+
"prompt": {
|
|
386
|
+
"anyOf": [
|
|
387
|
+
{
|
|
388
|
+
"type": "string"
|
|
389
|
+
},
|
|
390
|
+
{
|
|
391
|
+
"type": "null"
|
|
392
|
+
}
|
|
393
|
+
]
|
|
394
|
+
},
|
|
395
|
+
"voice": {
|
|
396
|
+
"anyOf": [
|
|
397
|
+
{
|
|
398
|
+
"type": "string"
|
|
399
|
+
},
|
|
400
|
+
{
|
|
401
|
+
"type": "null"
|
|
402
|
+
}
|
|
403
|
+
]
|
|
404
|
+
},
|
|
405
|
+
"language": {
|
|
406
|
+
"anyOf": [
|
|
407
|
+
{
|
|
408
|
+
"type": "string"
|
|
409
|
+
},
|
|
410
|
+
{
|
|
411
|
+
"type": "null"
|
|
412
|
+
}
|
|
413
|
+
]
|
|
414
|
+
},
|
|
415
|
+
"newscaster": {
|
|
416
|
+
"anyOf": [
|
|
417
|
+
{
|
|
418
|
+
"type": "boolean"
|
|
419
|
+
},
|
|
420
|
+
{
|
|
421
|
+
"type": "null"
|
|
422
|
+
}
|
|
423
|
+
]
|
|
424
|
+
},
|
|
425
|
+
"model": {
|
|
426
|
+
"anyOf": [
|
|
427
|
+
{
|
|
428
|
+
"type": "string"
|
|
429
|
+
},
|
|
430
|
+
{
|
|
431
|
+
"type": "null"
|
|
432
|
+
}
|
|
433
|
+
]
|
|
308
434
|
},
|
|
309
435
|
"trim": {
|
|
310
436
|
"anyOf": [
|
|
@@ -349,6 +475,11 @@
|
|
|
349
475
|
"required": [
|
|
350
476
|
"type",
|
|
351
477
|
"src",
|
|
478
|
+
"prompt",
|
|
479
|
+
"voice",
|
|
480
|
+
"language",
|
|
481
|
+
"newscaster",
|
|
482
|
+
"model",
|
|
352
483
|
"trim",
|
|
353
484
|
"volume",
|
|
354
485
|
"effect"
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "TextToImageAsset",
|
|
3
3
|
"strict": true,
|
|
4
4
|
"schema": {
|
|
5
|
-
"description": "
|
|
5
|
+
"description": "**Notice: TextToImageAsset is deprecated. Use [ImageAsset](#tocs_imageasset)\nwith `prompt` instead.** This type continues to function and is internally\nrewritten to ImageAsset; no behaviour change for existing integrations.\n\nThe TextToImageAsset lets you create a dynamic image from a text prompt.\n",
|
|
6
6
|
"properties": {
|
|
7
7
|
"type": {
|
|
8
8
|
"type": "string",
|
|
@@ -2,29 +2,29 @@
|
|
|
2
2
|
"name": "TextToSpeechAsset",
|
|
3
3
|
"strict": true,
|
|
4
4
|
"schema": {
|
|
5
|
-
"description": "
|
|
5
|
+
"description": "**Notice: TextToSpeechAsset is deprecated. Use [AudioAsset](#tocs_audioasset)\nwith `prompt` (the spoken text) and `voice` instead.** This type continues to\nfunction and is internally rewritten to AudioAsset; no behaviour change for\nexisting integrations.\n\nThe TextToSpeechAsset lets you generate a voice over from text using a text-to-speech service.\nThe generated audio can be trimmed, faded and have its volume and speed adjusted using the\nsame properties availabl...",
|
|
6
6
|
"type": "object",
|
|
7
7
|
"properties": {
|
|
8
8
|
"type": {
|
|
9
9
|
"type": "string",
|
|
10
|
-
"description": "The type of asset - set to `text-to-speech` for text-to-
|
|
10
|
+
"description": "The type of asset - set to `text-to-speech` for text-to-s...",
|
|
11
11
|
"enum": [
|
|
12
12
|
"text-to-speech"
|
|
13
13
|
]
|
|
14
14
|
},
|
|
15
15
|
"text": {
|
|
16
16
|
"type": "string",
|
|
17
|
-
"description": "The text to convert to
|
|
17
|
+
"description": "The text to convert to sp..."
|
|
18
18
|
},
|
|
19
19
|
"voice": {
|
|
20
20
|
"type": "string",
|
|
21
|
-
"description": "The voice to use for the text-to-speech
|
|
21
|
+
"description": "The voice to use for the text-to-speech conver..."
|
|
22
22
|
},
|
|
23
23
|
"language": {
|
|
24
24
|
"anyOf": [
|
|
25
25
|
{
|
|
26
26
|
"type": "string",
|
|
27
|
-
"description": "The language code for the text-to-speech
|
|
27
|
+
"description": "The language code for the text-to-speech conver..."
|
|
28
28
|
},
|
|
29
29
|
{
|
|
30
30
|
"type": "null"
|
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
"anyOf": [
|
|
36
36
|
{
|
|
37
37
|
"type": "boolean",
|
|
38
|
-
"description": "Set the voice to newscaster
|
|
38
|
+
"description": "Set the voice to newscaster ..."
|
|
39
39
|
},
|
|
40
40
|
{
|
|
41
41
|
"type": "null"
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"anyOf": [
|
|
47
47
|
{
|
|
48
48
|
"type": "number",
|
|
49
|
-
"description": "The start trim point of the audio clip, in seconds (defaults to 0). Audio will start from the trim point. The audio will play until the file ends or the Clip length
|
|
49
|
+
"description": "The start trim point of the audio clip, in seconds (defaults to 0). Audio will start from the trim point. The audio will play until the file ends or the Clip length i..."
|
|
50
50
|
},
|
|
51
51
|
{
|
|
52
52
|
"type": "null"
|
|
@@ -54,17 +54,17 @@
|
|
|
54
54
|
]
|
|
55
55
|
},
|
|
56
56
|
"volume": {
|
|
57
|
-
"description": "Set the volume of the audio clip. Use a number or an array of [Tween](./#tocs_tween) objects to create custom volume
|
|
57
|
+
"description": "Set the volume of the audio clip. Use a number or an array of [Tween](./#tocs_tween) objects to create custom volume tran...",
|
|
58
58
|
"anyOf": [
|
|
59
59
|
{
|
|
60
60
|
"type": "number",
|
|
61
|
-
"description": "The volume level for the audio clip. Range varies from 0 to 1 where 0 is muted and 1 is full volume (
|
|
61
|
+
"description": "The volume level for the audio clip. Range varies from 0 to 1 where 0 is muted and 1 is full volume (default...",
|
|
62
62
|
"minimum": 0,
|
|
63
63
|
"maximum": 1
|
|
64
64
|
},
|
|
65
65
|
{
|
|
66
66
|
"type": "array",
|
|
67
|
-
"description": "An array of [Tween](./#tocs_tween) objects used to create a custom volume effect. Modify the volume of an asset
|
|
67
|
+
"description": "An array of [Tween](./#tocs_tween) objects used to create a custom volume effect. Modify the volume of an asset ov...",
|
|
68
68
|
"items": {
|
|
69
69
|
"$ref": "#/$defs/Tween"
|
|
70
70
|
}
|
|
@@ -78,7 +78,7 @@
|
|
|
78
78
|
"anyOf": [
|
|
79
79
|
{
|
|
80
80
|
"type": "number",
|
|
81
|
-
"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
|
|
81
|
+
"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 ...",
|
|
82
82
|
"minimum": 0,
|
|
83
83
|
"maximum": 10
|
|
84
84
|
},
|
|
@@ -91,7 +91,7 @@
|
|
|
91
91
|
"anyOf": [
|
|
92
92
|
{
|
|
93
93
|
"type": "string",
|
|
94
|
-
"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
|
|
94
|
+
"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<...",
|
|
95
95
|
"enum": [
|
|
96
96
|
"none",
|
|
97
97
|
"fadeIn",
|
|
@@ -119,13 +119,13 @@
|
|
|
119
119
|
],
|
|
120
120
|
"$defs": {
|
|
121
121
|
"Tween": {
|
|
122
|
-
"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
|
|
122
|
+
"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...",
|
|
123
123
|
"properties": {
|
|
124
124
|
"from": {
|
|
125
125
|
"anyOf": [
|
|
126
126
|
{
|
|
127
127
|
"type": "string",
|
|
128
|
-
"description": "The initial property value at the start of the
|
|
128
|
+
"description": "The initial property value at the start of the anim..."
|
|
129
129
|
},
|
|
130
130
|
{
|
|
131
131
|
"type": "null"
|
|
@@ -136,7 +136,7 @@
|
|
|
136
136
|
"anyOf": [
|
|
137
137
|
{
|
|
138
138
|
"type": "string",
|
|
139
|
-
"description": "The final property value at the end of the
|
|
139
|
+
"description": "The final property value at the end of the anima..."
|
|
140
140
|
},
|
|
141
141
|
{
|
|
142
142
|
"type": "null"
|
|
@@ -147,7 +147,7 @@
|
|
|
147
147
|
"anyOf": [
|
|
148
148
|
{
|
|
149
149
|
"type": "number",
|
|
150
|
-
"description": "The time in seconds when the animation starts, relative to the clip, not the
|
|
150
|
+
"description": "The time in seconds when the animation starts, relative to the clip, not the ti..."
|
|
151
151
|
},
|
|
152
152
|
{
|
|
153
153
|
"type": "null"
|
|
@@ -158,7 +158,7 @@
|
|
|
158
158
|
"anyOf": [
|
|
159
159
|
{
|
|
160
160
|
"type": "number",
|
|
161
|
-
"description": "The duration of the animation in
|
|
161
|
+
"description": "The duration of the animation in sec..."
|
|
162
162
|
},
|
|
163
163
|
{
|
|
164
164
|
"type": "null"
|
|
@@ -169,7 +169,7 @@
|
|
|
169
169
|
"anyOf": [
|
|
170
170
|
{
|
|
171
171
|
"type": "string",
|
|
172
|
-
"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
|
|
172
|
+
"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 trans...",
|
|
173
173
|
"enum": [
|
|
174
174
|
"linear",
|
|
175
175
|
"bezier",
|
|
@@ -185,7 +185,7 @@
|
|
|
185
185
|
"anyOf": [
|
|
186
186
|
{
|
|
187
187
|
"type": "string",
|
|
188
|
-
"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
|
|
188
|
+
"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...",
|
|
189
189
|
"enum": [
|
|
190
190
|
"ease",
|
|
191
191
|
"easeIn",
|