@shotstack/schemas 1.13.0 → 1.13.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 +13 -6
- package/dist/json-schema/asset.json +11 -0
- package/dist/json-schema/clip.json +11 -0
- package/dist/json-schema/edit.json +11 -0
- package/dist/json-schema/image-to-video-asset.json +1 -1
- package/dist/json-schema/schemas.json +18 -6
- package/dist/json-schema/template.json +11 -0
- package/dist/json-schema/timeline.json +11 -0
- package/dist/json-schema/track.json +11 -0
- package/dist/json-schema/video-asset.json +41 -29
- package/dist/schema.d.ts +15 -9
- package/dist/zod/zod.gen.cjs +19 -7
- package/dist/zod/zod.gen.d.ts +75 -6
- package/dist/zod/zod.gen.js +19 -7
- package/dist/zod/zod.gen.ts +19 -7
- package/package.json +1 -1
package/dist/api.bundled.json
CHANGED
|
@@ -1189,7 +1189,7 @@
|
|
|
1189
1189
|
"additionalProperties": false
|
|
1190
1190
|
},
|
|
1191
1191
|
"VideoAsset": {
|
|
1192
|
-
"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
|
|
1192
|
+
"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 from a\nstarting image (`inputSrc`). 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 `inputSrc`\n to 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",
|
|
1193
1193
|
"type": "object",
|
|
1194
1194
|
"properties": {
|
|
1195
1195
|
"type": {
|
|
@@ -1208,13 +1208,20 @@
|
|
|
1208
1208
|
"example": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/video.mp4"
|
|
1209
1209
|
},
|
|
1210
1210
|
"prompt": {
|
|
1211
|
-
"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 `
|
|
1211
|
+
"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 `inputSrc` for image-to-video. Use `model` to choose the generator.",
|
|
1212
1212
|
"type": "string",
|
|
1213
1213
|
"maxLength": 4000,
|
|
1214
1214
|
"example": "Slowly zoom out and orbit left around the object."
|
|
1215
1215
|
},
|
|
1216
|
+
"inputSrc": {
|
|
1217
|
+
"description": "Input 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.",
|
|
1218
|
+
"type": "string",
|
|
1219
|
+
"minLength": 1,
|
|
1220
|
+
"example": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/input-image.jpg"
|
|
1221
|
+
},
|
|
1216
1222
|
"seed": {
|
|
1217
|
-
"
|
|
1223
|
+
"deprecated": true,
|
|
1224
|
+
"description": "**Deprecated — use `inputSrc`.** Legacy alias for the image-to-video input image URL, accepted and normalised to `inputSrc` on ingest. The name is misleading — industry-wide `seed` means an integer RNG sampling seed — and will be removed in a future major version.",
|
|
1218
1225
|
"type": "string",
|
|
1219
1226
|
"minLength": 1,
|
|
1220
1227
|
"example": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/seed-image.jpg"
|
|
@@ -2201,7 +2208,7 @@
|
|
|
2201
2208
|
},
|
|
2202
2209
|
"ImageToVideoAsset": {
|
|
2203
2210
|
"deprecated": true,
|
|
2204
|
-
"description": "**Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)\nwith `prompt` and `
|
|
2211
|
+
"description": "**Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)\nwith `prompt` and `inputSrc` 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",
|
|
2205
2212
|
"properties": {
|
|
2206
2213
|
"type": {
|
|
2207
2214
|
"type": "string",
|
|
@@ -3545,7 +3552,7 @@
|
|
|
3545
3552
|
]
|
|
3546
3553
|
},
|
|
3547
3554
|
"Output": {
|
|
3548
|
-
"description": "The output format, render range and type of media to generate.",
|
|
3555
|
+
"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.",
|
|
3549
3556
|
"properties": {
|
|
3550
3557
|
"format": {
|
|
3551
3558
|
"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>",
|
|
@@ -3561,7 +3568,7 @@
|
|
|
3561
3568
|
"example": "mp4"
|
|
3562
3569
|
},
|
|
3563
3570
|
"resolution": {
|
|
3564
|
-
"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>",
|
|
3571
|
+
"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>",
|
|
3565
3572
|
"enum": [
|
|
3566
3573
|
"preview",
|
|
3567
3574
|
"mobile",
|
|
@@ -70,6 +70,16 @@
|
|
|
70
70
|
}
|
|
71
71
|
]
|
|
72
72
|
},
|
|
73
|
+
"inputSrc": {
|
|
74
|
+
"anyOf": [
|
|
75
|
+
{
|
|
76
|
+
"type": "string"
|
|
77
|
+
},
|
|
78
|
+
{
|
|
79
|
+
"type": "null"
|
|
80
|
+
}
|
|
81
|
+
]
|
|
82
|
+
},
|
|
73
83
|
"seed": {
|
|
74
84
|
"anyOf": [
|
|
75
85
|
{
|
|
@@ -182,6 +192,7 @@
|
|
|
182
192
|
"type",
|
|
183
193
|
"src",
|
|
184
194
|
"prompt",
|
|
195
|
+
"inputSrc",
|
|
185
196
|
"seed",
|
|
186
197
|
"model",
|
|
187
198
|
"transcode",
|
|
@@ -313,6 +313,16 @@
|
|
|
313
313
|
}
|
|
314
314
|
]
|
|
315
315
|
},
|
|
316
|
+
"inputSrc": {
|
|
317
|
+
"anyOf": [
|
|
318
|
+
{
|
|
319
|
+
"type": "string"
|
|
320
|
+
},
|
|
321
|
+
{
|
|
322
|
+
"type": "null"
|
|
323
|
+
}
|
|
324
|
+
]
|
|
325
|
+
},
|
|
316
326
|
"seed": {
|
|
317
327
|
"anyOf": [
|
|
318
328
|
{
|
|
@@ -425,6 +435,7 @@
|
|
|
425
435
|
"type",
|
|
426
436
|
"src",
|
|
427
437
|
"prompt",
|
|
438
|
+
"inputSrc",
|
|
428
439
|
"seed",
|
|
429
440
|
"model",
|
|
430
441
|
"transcode",
|
|
@@ -497,6 +497,16 @@
|
|
|
497
497
|
}
|
|
498
498
|
]
|
|
499
499
|
},
|
|
500
|
+
"inputSrc": {
|
|
501
|
+
"anyOf": [
|
|
502
|
+
{
|
|
503
|
+
"type": "string"
|
|
504
|
+
},
|
|
505
|
+
{
|
|
506
|
+
"type": "null"
|
|
507
|
+
}
|
|
508
|
+
]
|
|
509
|
+
},
|
|
500
510
|
"seed": {
|
|
501
511
|
"anyOf": [
|
|
502
512
|
{
|
|
@@ -609,6 +619,7 @@
|
|
|
609
619
|
"type",
|
|
610
620
|
"src",
|
|
611
621
|
"prompt",
|
|
622
|
+
"inputSrc",
|
|
612
623
|
"seed",
|
|
613
624
|
"model",
|
|
614
625
|
"transcode",
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "ImageToVideoAsset",
|
|
3
3
|
"strict": true,
|
|
4
4
|
"schema": {
|
|
5
|
-
"description": "**Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)\nwith `prompt` and `
|
|
5
|
+
"description": "**Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)\nwith `prompt` and `inputSrc` 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",
|
|
6
6
|
"properties": {
|
|
7
7
|
"type": {
|
|
8
8
|
"type": "string",
|
|
@@ -450,7 +450,7 @@
|
|
|
450
450
|
]
|
|
451
451
|
},
|
|
452
452
|
"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
|
|
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 from a\nstarting image (`inputSrc`). 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 `inputSrc`\n to 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": {
|
|
@@ -475,7 +475,18 @@
|
|
|
475
475
|
"anyOf": [
|
|
476
476
|
{
|
|
477
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 `
|
|
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 `inputSrc` for image-to-video. Use `model` to choose the generator."
|
|
479
|
+
},
|
|
480
|
+
{
|
|
481
|
+
"type": "null"
|
|
482
|
+
}
|
|
483
|
+
]
|
|
484
|
+
},
|
|
485
|
+
"inputSrc": {
|
|
486
|
+
"anyOf": [
|
|
487
|
+
{
|
|
488
|
+
"type": "string",
|
|
489
|
+
"description": "Input 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."
|
|
479
490
|
},
|
|
480
491
|
{
|
|
481
492
|
"type": "null"
|
|
@@ -486,7 +497,7 @@
|
|
|
486
497
|
"anyOf": [
|
|
487
498
|
{
|
|
488
499
|
"type": "string",
|
|
489
|
-
"description": "
|
|
500
|
+
"description": "**Deprecated — use `inputSrc`.** Legacy alias for the image-to-video input image URL, accepted and normalised to `inputSrc` on ingest. The name is misleading — industry-wide `seed` means an integer RNG sampling seed — and will be removed in a future major version."
|
|
490
501
|
},
|
|
491
502
|
{
|
|
492
503
|
"type": "null"
|
|
@@ -603,6 +614,7 @@
|
|
|
603
614
|
"type",
|
|
604
615
|
"src",
|
|
605
616
|
"prompt",
|
|
617
|
+
"inputSrc",
|
|
606
618
|
"seed",
|
|
607
619
|
"model",
|
|
608
620
|
"transcode",
|
|
@@ -3019,7 +3031,7 @@
|
|
|
3019
3031
|
]
|
|
3020
3032
|
},
|
|
3021
3033
|
"ImageToVideoAsset": {
|
|
3022
|
-
"description": "**Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)\nwith `prompt` and `
|
|
3034
|
+
"description": "**Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)\nwith `prompt` and `inputSrc` 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",
|
|
3023
3035
|
"properties": {
|
|
3024
3036
|
"type": {
|
|
3025
3037
|
"type": "string",
|
|
@@ -3509,7 +3521,7 @@
|
|
|
3509
3521
|
]
|
|
3510
3522
|
},
|
|
3511
3523
|
"Output": {
|
|
3512
|
-
"description": "The output format, render range and type of media to generate.",
|
|
3524
|
+
"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.",
|
|
3513
3525
|
"properties": {
|
|
3514
3526
|
"format": {
|
|
3515
3527
|
"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>",
|
|
@@ -3527,7 +3539,7 @@
|
|
|
3527
3539
|
"anyOf": [
|
|
3528
3540
|
{
|
|
3529
3541
|
"type": "string",
|
|
3530
|
-
"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>",
|
|
3542
|
+
"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>",
|
|
3531
3543
|
"enum": [
|
|
3532
3544
|
"preview",
|
|
3533
3545
|
"mobile",
|
|
@@ -231,6 +231,16 @@
|
|
|
231
231
|
}
|
|
232
232
|
]
|
|
233
233
|
},
|
|
234
|
+
"inputSrc": {
|
|
235
|
+
"anyOf": [
|
|
236
|
+
{
|
|
237
|
+
"type": "string"
|
|
238
|
+
},
|
|
239
|
+
{
|
|
240
|
+
"type": "null"
|
|
241
|
+
}
|
|
242
|
+
]
|
|
243
|
+
},
|
|
234
244
|
"seed": {
|
|
235
245
|
"anyOf": [
|
|
236
246
|
{
|
|
@@ -307,6 +317,7 @@
|
|
|
307
317
|
"type",
|
|
308
318
|
"src",
|
|
309
319
|
"prompt",
|
|
320
|
+
"inputSrc",
|
|
310
321
|
"seed",
|
|
311
322
|
"model",
|
|
312
323
|
"trim",
|
|
@@ -441,6 +441,16 @@
|
|
|
441
441
|
}
|
|
442
442
|
]
|
|
443
443
|
},
|
|
444
|
+
"inputSrc": {
|
|
445
|
+
"anyOf": [
|
|
446
|
+
{
|
|
447
|
+
"type": "string"
|
|
448
|
+
},
|
|
449
|
+
{
|
|
450
|
+
"type": "null"
|
|
451
|
+
}
|
|
452
|
+
]
|
|
453
|
+
},
|
|
444
454
|
"seed": {
|
|
445
455
|
"anyOf": [
|
|
446
456
|
{
|
|
@@ -553,6 +563,7 @@
|
|
|
553
563
|
"type",
|
|
554
564
|
"src",
|
|
555
565
|
"prompt",
|
|
566
|
+
"inputSrc",
|
|
556
567
|
"seed",
|
|
557
568
|
"model",
|
|
558
569
|
"transcode",
|
|
@@ -328,6 +328,16 @@
|
|
|
328
328
|
}
|
|
329
329
|
]
|
|
330
330
|
},
|
|
331
|
+
"inputSrc": {
|
|
332
|
+
"anyOf": [
|
|
333
|
+
{
|
|
334
|
+
"type": "string"
|
|
335
|
+
},
|
|
336
|
+
{
|
|
337
|
+
"type": "null"
|
|
338
|
+
}
|
|
339
|
+
]
|
|
340
|
+
},
|
|
331
341
|
"seed": {
|
|
332
342
|
"anyOf": [
|
|
333
343
|
{
|
|
@@ -440,6 +450,7 @@
|
|
|
440
450
|
"type",
|
|
441
451
|
"src",
|
|
442
452
|
"prompt",
|
|
453
|
+
"inputSrc",
|
|
443
454
|
"seed",
|
|
444
455
|
"model",
|
|
445
456
|
"transcode",
|
|
@@ -2,21 +2,21 @@
|
|
|
2
2
|
"name": "VideoAsset",
|
|
3
3
|
"strict": true,
|
|
4
4
|
"schema": {
|
|
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
|
|
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 from a\nstarting image (`inputSrc`)....",
|
|
6
6
|
"type": "object",
|
|
7
7
|
"properties": {
|
|
8
8
|
"type": {
|
|
9
9
|
"enum": [
|
|
10
10
|
"video"
|
|
11
11
|
],
|
|
12
|
-
"description": "The type of
|
|
12
|
+
"description": "The type of...",
|
|
13
13
|
"type": "string"
|
|
14
14
|
},
|
|
15
15
|
"src": {
|
|
16
16
|
"anyOf": [
|
|
17
17
|
{
|
|
18
18
|
"type": "string",
|
|
19
|
-
"description": "The video source URL. The URL must
|
|
19
|
+
"description": "The video source URL. The URL must b..."
|
|
20
20
|
},
|
|
21
21
|
{
|
|
22
22
|
"type": "null"
|
|
@@ -27,7 +27,18 @@
|
|
|
27
27
|
"anyOf": [
|
|
28
28
|
{
|
|
29
29
|
"type": "string",
|
|
30
|
-
"description": "A text prompt to generate the video from. When set without `src
|
|
30
|
+
"description": "A text prompt to generate the video from. When set without `src`,..."
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
"type": "null"
|
|
34
|
+
}
|
|
35
|
+
]
|
|
36
|
+
},
|
|
37
|
+
"inputSrc": {
|
|
38
|
+
"anyOf": [
|
|
39
|
+
{
|
|
40
|
+
"type": "string",
|
|
41
|
+
"description": "Input image URL for image-to-video generation...."
|
|
31
42
|
},
|
|
32
43
|
{
|
|
33
44
|
"type": "null"
|
|
@@ -38,7 +49,7 @@
|
|
|
38
49
|
"anyOf": [
|
|
39
50
|
{
|
|
40
51
|
"type": "string",
|
|
41
|
-
"description": "
|
|
52
|
+
"description": "**Deprecated — use `inputSrc`.** Legacy alias for the image-to-video input image..."
|
|
42
53
|
},
|
|
43
54
|
{
|
|
44
55
|
"type": "null"
|
|
@@ -49,7 +60,7 @@
|
|
|
49
60
|
"anyOf": [
|
|
50
61
|
{
|
|
51
62
|
"type": "string",
|
|
52
|
-
"description": "The generation model to use when `prompt`
|
|
63
|
+
"description": "The generation model to use when `prompt` i..."
|
|
53
64
|
},
|
|
54
65
|
{
|
|
55
66
|
"type": "null"
|
|
@@ -60,7 +71,7 @@
|
|
|
60
71
|
"anyOf": [
|
|
61
72
|
{
|
|
62
73
|
"type": "boolean",
|
|
63
|
-
"description": "Set to `true` to force re-encoding of the video during preprocessing. This can
|
|
74
|
+
"description": "Set to `true` to force re-encoding of the video during preprocessing. This can h..."
|
|
64
75
|
},
|
|
65
76
|
{
|
|
66
77
|
"type": "null"
|
|
@@ -71,7 +82,7 @@
|
|
|
71
82
|
"anyOf": [
|
|
72
83
|
{
|
|
73
84
|
"type": "number",
|
|
74
|
-
"description": "The start trim point of the video clip, in seconds (
|
|
85
|
+
"description": "The start trim point of the video clip, in seconds (de..."
|
|
75
86
|
},
|
|
76
87
|
{
|
|
77
88
|
"type": "null"
|
|
@@ -79,17 +90,17 @@
|
|
|
79
90
|
]
|
|
80
91
|
},
|
|
81
92
|
"volume": {
|
|
82
|
-
"description": "Set the volume of the video clip. Use
|
|
93
|
+
"description": "Set the volume of the video clip. Use ...",
|
|
83
94
|
"anyOf": [
|
|
84
95
|
{
|
|
85
96
|
"type": "number",
|
|
86
|
-
"description": "The volume level for the video
|
|
97
|
+
"description": "The volume level for the video cl...",
|
|
87
98
|
"minimum": 0,
|
|
88
99
|
"maximum": 1
|
|
89
100
|
},
|
|
90
101
|
{
|
|
91
102
|
"type": "array",
|
|
92
|
-
"description": "An array of [Tween](./#tocs_tween)
|
|
103
|
+
"description": "An array of [Tween](./#tocs_tween) ...",
|
|
93
104
|
"items": {
|
|
94
105
|
"$ref": "#/$defs/Tween"
|
|
95
106
|
}
|
|
@@ -103,7 +114,7 @@
|
|
|
103
114
|
"anyOf": [
|
|
104
115
|
{
|
|
105
116
|
"type": "string",
|
|
106
|
-
"description": "Preset volume effects to apply to the video asset <ul>\n <
|
|
117
|
+
"description": "Preset volume effects to apply to the video asset <ul>\n <l...",
|
|
107
118
|
"enum": [
|
|
108
119
|
"none",
|
|
109
120
|
"fadeIn",
|
|
@@ -120,7 +131,7 @@
|
|
|
120
131
|
"anyOf": [
|
|
121
132
|
{
|
|
122
133
|
"type": "number",
|
|
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
|
|
134
|
+
"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 ...",
|
|
124
135
|
"minimum": 0,
|
|
125
136
|
"maximum": 10
|
|
126
137
|
},
|
|
@@ -155,6 +166,7 @@
|
|
|
155
166
|
"type",
|
|
156
167
|
"src",
|
|
157
168
|
"prompt",
|
|
169
|
+
"inputSrc",
|
|
158
170
|
"seed",
|
|
159
171
|
"model",
|
|
160
172
|
"transcode",
|
|
@@ -167,13 +179,13 @@
|
|
|
167
179
|
],
|
|
168
180
|
"$defs": {
|
|
169
181
|
"Tween": {
|
|
170
|
-
"description": "Use a Tween to [animate properties over time](/docs/guide/architecting-an-application/animations/). The following properties are currently supported and
|
|
182
|
+
"description": "Use a Tween to [animate properties over time](/docs/guide/architecting-an-application/animations/). The following properties are currently supported and ...",
|
|
171
183
|
"properties": {
|
|
172
184
|
"from": {
|
|
173
185
|
"anyOf": [
|
|
174
186
|
{
|
|
175
187
|
"type": "string",
|
|
176
|
-
"description": "The initial
|
|
188
|
+
"description": "The initial pro..."
|
|
177
189
|
},
|
|
178
190
|
{
|
|
179
191
|
"type": "null"
|
|
@@ -184,7 +196,7 @@
|
|
|
184
196
|
"anyOf": [
|
|
185
197
|
{
|
|
186
198
|
"type": "string",
|
|
187
|
-
"description": "The final
|
|
199
|
+
"description": "The final pro..."
|
|
188
200
|
},
|
|
189
201
|
{
|
|
190
202
|
"type": "null"
|
|
@@ -195,7 +207,7 @@
|
|
|
195
207
|
"anyOf": [
|
|
196
208
|
{
|
|
197
209
|
"type": "number",
|
|
198
|
-
"description": "The time in seconds when
|
|
210
|
+
"description": "The time in seconds when..."
|
|
199
211
|
},
|
|
200
212
|
{
|
|
201
213
|
"type": "null"
|
|
@@ -206,7 +218,7 @@
|
|
|
206
218
|
"anyOf": [
|
|
207
219
|
{
|
|
208
220
|
"type": "number",
|
|
209
|
-
"description": "The
|
|
221
|
+
"description": "The durati..."
|
|
210
222
|
},
|
|
211
223
|
{
|
|
212
224
|
"type": "null"
|
|
@@ -217,7 +229,7 @@
|
|
|
217
229
|
"anyOf": [
|
|
218
230
|
{
|
|
219
231
|
"type": "string",
|
|
220
|
-
"description": "The interpolation method to use for the animation. Available options are: <ul>\n <li>`linear` - a linear interpolation
|
|
232
|
+
"description": "The interpolation method to use for the animation. Available options are: <ul>\n <li>`linear` - a linear interpolation b...",
|
|
221
233
|
"enum": [
|
|
222
234
|
"linear",
|
|
223
235
|
"bezier",
|
|
@@ -233,7 +245,7 @@
|
|
|
233
245
|
"anyOf": [
|
|
234
246
|
{
|
|
235
247
|
"type": "string",
|
|
236
|
-
"description": "The easing function to use for the animation. Easing controls the rate of
|
|
248
|
+
"description": "The easing function to use for the animation. Easing controls the rate of chan...",
|
|
237
249
|
"enum": [
|
|
238
250
|
"ease",
|
|
239
251
|
"easeIn",
|
|
@@ -283,13 +295,13 @@
|
|
|
283
295
|
]
|
|
284
296
|
},
|
|
285
297
|
"Crop": {
|
|
286
|
-
"description": "Crop the sides of an asset by a relative amount. The size of the crop is specified
|
|
298
|
+
"description": "Crop the sides of an asset by a relative amount. The size of the crop is specified ...",
|
|
287
299
|
"properties": {
|
|
288
300
|
"top": {
|
|
289
301
|
"anyOf": [
|
|
290
302
|
{
|
|
291
303
|
"type": "number",
|
|
292
|
-
"description": "Crop
|
|
304
|
+
"description": "Crop f...",
|
|
293
305
|
"minimum": 0,
|
|
294
306
|
"maximum": 1
|
|
295
307
|
},
|
|
@@ -302,7 +314,7 @@
|
|
|
302
314
|
"anyOf": [
|
|
303
315
|
{
|
|
304
316
|
"type": "number",
|
|
305
|
-
"description": "Crop
|
|
317
|
+
"description": "Crop fr...",
|
|
306
318
|
"minimum": 0,
|
|
307
319
|
"maximum": 1
|
|
308
320
|
},
|
|
@@ -315,7 +327,7 @@
|
|
|
315
327
|
"anyOf": [
|
|
316
328
|
{
|
|
317
329
|
"type": "number",
|
|
318
|
-
"description": "Crop
|
|
330
|
+
"description": "Crop f...",
|
|
319
331
|
"minimum": 0,
|
|
320
332
|
"maximum": 1
|
|
321
333
|
},
|
|
@@ -328,7 +340,7 @@
|
|
|
328
340
|
"anyOf": [
|
|
329
341
|
{
|
|
330
342
|
"type": "number",
|
|
331
|
-
"description": "Crop
|
|
343
|
+
"description": "Crop f...",
|
|
332
344
|
"minimum": 0,
|
|
333
345
|
"maximum": 1
|
|
334
346
|
},
|
|
@@ -348,17 +360,17 @@
|
|
|
348
360
|
]
|
|
349
361
|
},
|
|
350
362
|
"ChromaKey": {
|
|
351
|
-
"description": "Chroma key is a technique that replaces a specific color in a video
|
|
363
|
+
"description": "Chroma key is a technique that replaces a specific color in a video...",
|
|
352
364
|
"properties": {
|
|
353
365
|
"color": {
|
|
354
|
-
"description": "The chroma key color as a hex value. Use green
|
|
366
|
+
"description": "The chroma key color as a hex value. Use green ...",
|
|
355
367
|
"type": "string"
|
|
356
368
|
},
|
|
357
369
|
"threshold": {
|
|
358
370
|
"anyOf": [
|
|
359
371
|
{
|
|
360
372
|
"type": "integer",
|
|
361
|
-
"description": "Pixels within this distance
|
|
373
|
+
"description": "Pixels within this distance ...",
|
|
362
374
|
"minimum": 0,
|
|
363
375
|
"maximum": 250
|
|
364
376
|
},
|
|
@@ -371,7 +383,7 @@
|
|
|
371
383
|
"anyOf": [
|
|
372
384
|
{
|
|
373
385
|
"type": "integer",
|
|
374
|
-
"description": "Pixels within the halo distance from the
|
|
386
|
+
"description": "Pixels within the halo distance from the ...",
|
|
375
387
|
"minimum": 0,
|
|
376
388
|
"maximum": 250
|
|
377
389
|
},
|
package/dist/schema.d.ts
CHANGED
|
@@ -552,12 +552,12 @@ export interface components {
|
|
|
552
552
|
Asset: components["schemas"]["VideoAsset"] | components["schemas"]["ImageAsset"] | components["schemas"]["TextAsset"] | components["schemas"]["RichTextAsset"] | components["schemas"]["AudioAsset"] | components["schemas"]["LumaAsset"] | components["schemas"]["CaptionAsset"] | components["schemas"]["RichCaptionAsset"] | components["schemas"]["HtmlAsset"] | components["schemas"]["Html5Asset"] | components["schemas"]["TitleAsset"] | components["schemas"]["ShapeAsset"] | components["schemas"]["SvgAsset"] | components["schemas"]["TextToImageAsset"] | components["schemas"]["ImageToVideoAsset"] | components["schemas"]["TextToSpeechAsset"];
|
|
553
553
|
/**
|
|
554
554
|
* @description The VideoAsset adds a video to a Clip. The video can be sourced from a URL
|
|
555
|
-
* (`src`) or generated from a text prompt (`prompt`), optionally
|
|
556
|
-
* starting image (`
|
|
555
|
+
* (`src`) or generated from a text prompt (`prompt`), optionally from a
|
|
556
|
+
* starting image (`inputSrc`). Exactly one of `src` or `prompt` must be provided.
|
|
557
557
|
*
|
|
558
558
|
* - **Source URL:** set `src` to the URL of an mp4 (or compatible) video file.
|
|
559
|
-
* - **Generated:** set `prompt` to describe the motion. Optionally set `
|
|
560
|
-
* a starting image URL (image-to-video). Use `model` to choose the generator
|
|
559
|
+
* - **Generated:** set `prompt` to describe the motion. Optionally set `inputSrc`
|
|
560
|
+
* to a starting image URL (image-to-video). Use `model` to choose the generator
|
|
561
561
|
* (e.g. `luma-ray-3`, `runpod-itv-mini`). The generated `src` is filled in
|
|
562
562
|
* automatically.
|
|
563
563
|
*/
|
|
@@ -573,12 +573,18 @@ export interface components {
|
|
|
573
573
|
*/
|
|
574
574
|
src?: string;
|
|
575
575
|
/**
|
|
576
|
-
* @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 `
|
|
576
|
+
* @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 `inputSrc` for image-to-video. Use `model` to choose the generator.
|
|
577
577
|
* @example Slowly zoom out and orbit left around the object.
|
|
578
578
|
*/
|
|
579
579
|
prompt?: string;
|
|
580
580
|
/**
|
|
581
|
-
* @description
|
|
581
|
+
* @description Input 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.
|
|
582
|
+
* @example https://s3-ap-northeast-1.amazonaws.com/my-bucket/input-image.jpg
|
|
583
|
+
*/
|
|
584
|
+
inputSrc?: string;
|
|
585
|
+
/**
|
|
586
|
+
* @deprecated
|
|
587
|
+
* @description **Deprecated — use `inputSrc`.** Legacy alias for the image-to-video input image URL, accepted and normalised to `inputSrc` on ingest. The name is misleading — industry-wide `seed` means an integer RNG sampling seed — and will be removed in a future major version.
|
|
582
588
|
* @example https://s3-ap-northeast-1.amazonaws.com/my-bucket/seed-image.jpg
|
|
583
589
|
*/
|
|
584
590
|
seed?: string;
|
|
@@ -1230,7 +1236,7 @@ export interface components {
|
|
|
1230
1236
|
/**
|
|
1231
1237
|
* @deprecated
|
|
1232
1238
|
* @description **Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)
|
|
1233
|
-
* with `prompt` and `
|
|
1239
|
+
* with `prompt` and `inputSrc` instead.** This type continues to function and is
|
|
1234
1240
|
* internally rewritten to VideoAsset; no behaviour change for existing
|
|
1235
1241
|
* integrations.
|
|
1236
1242
|
*
|
|
@@ -2119,7 +2125,7 @@ export interface components {
|
|
|
2119
2125
|
*/
|
|
2120
2126
|
replace: unknown;
|
|
2121
2127
|
};
|
|
2122
|
-
/** @description The output format, render range and type of media to generate. */
|
|
2128
|
+
/** @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. */
|
|
2123
2129
|
Output: {
|
|
2124
2130
|
/**
|
|
2125
2131
|
* @description The output format and type of media file to generate. <ul>
|
|
@@ -2135,7 +2141,7 @@ export interface components {
|
|
|
2135
2141
|
*/
|
|
2136
2142
|
format: "mp4" | "gif" | "mp3" | "jpg" | "png" | "bmp";
|
|
2137
2143
|
/**
|
|
2138
|
-
* @description The preset output resolution of the video or image. For custom sizes use the `size` property. <ul>
|
|
2144
|
+
* @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>
|
|
2139
2145
|
* <li>`preview` - 512px x 288px @ 15fps</li>
|
|
2140
2146
|
* <li>`mobile` - 640px x 360px @ 25fps</li>
|
|
2141
2147
|
* <li>`sd` - 1024px x 576px @ 25fps</li>
|