@shotstack/schemas 1.18.0 → 1.18.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 +7 -5
- package/dist/json-schema/edit.json +5 -4
- package/dist/json-schema/index.cjs +1 -1
- package/dist/json-schema/index.js +1 -1
- package/dist/schema.d.ts +14 -8
- package/dist/zod/zod.gen.cjs +12 -5
- package/dist/zod/zod.gen.d.ts +16 -5
- package/dist/zod/zod.gen.js +12 -5
- package/dist/zod/zod.gen.ts +12 -5
- package/package.json +1 -1
package/dist/api.bundled.json
CHANGED
|
@@ -1533,7 +1533,7 @@
|
|
|
1533
1533
|
"additionalProperties": false
|
|
1534
1534
|
},
|
|
1535
1535
|
"VideoAsset": {
|
|
1536
|
-
"description": "The VideoAsset adds a video to a Clip. The video 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 URL of an mp4 (or compatible) video file.\n- **Generated:** set `prompt` to describe the motion. Choose a generator\n with `model` and configure it with model-specific `options
|
|
1536
|
+
"description": "The VideoAsset adds a video to a Clip. The video 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 URL of an mp4 (or compatible) video file.\n- **Generated:** set `prompt` to describe the motion. Choose a generator\n with `model` and configure it with model-specific `options`. Models that\n animate a starting image take it as `options.inputSrc`; the default model\n generates from the prompt alone. The generated `src` is filled in\n automatically.\n- **Both:** `src` acts as a preview placeholder while `prompt` drives\n generation — the video is regenerated from the prompt at render time.\n Unchanged prompts and options resolve from the generation cache.\n",
|
|
1537
1537
|
"type": "object",
|
|
1538
1538
|
"properties": {
|
|
1539
1539
|
"type": {
|
|
@@ -1552,7 +1552,7 @@
|
|
|
1552
1552
|
"example": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/video.mp4"
|
|
1553
1553
|
},
|
|
1554
1554
|
"prompt": {
|
|
1555
|
-
"description": "A text prompt to generate the video from. The engine generates a video at render time and fills `src` automatically; an existing `src` is treated as a preview placeholder and replaced. Use `model` to choose the generator and `options` to configure it
|
|
1555
|
+
"description": "A text prompt to generate the video from. The engine generates a video at render time and fills `src` automatically; an existing `src` is treated as a preview placeholder and replaced. Use `model` to choose the generator and `options` to configure it. A starting image goes in `options.inputSrc`, on the models that accept one.",
|
|
1556
1556
|
"type": "string",
|
|
1557
1557
|
"maxLength": 4000,
|
|
1558
1558
|
"example": "Slowly zoom out and orbit left around the object."
|
|
@@ -2164,7 +2164,8 @@
|
|
|
2164
2164
|
]
|
|
2165
2165
|
},
|
|
2166
2166
|
"CaptionAsset": {
|
|
2167
|
-
"
|
|
2167
|
+
"deprecated": true,
|
|
2168
|
+
"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.\n",
|
|
2168
2169
|
"type": "object",
|
|
2169
2170
|
"properties": {
|
|
2170
2171
|
"type": {
|
|
@@ -2563,7 +2564,7 @@
|
|
|
2563
2564
|
},
|
|
2564
2565
|
"ImageToVideoAsset": {
|
|
2565
2566
|
"deprecated": true,
|
|
2566
|
-
"description": "**Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)\nwith `prompt` and `inputSrc`
|
|
2567
|
+
"description": "**Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)\nwith `prompt`, a `model` that accepts a starting image, and that image in\n`options.inputSrc` — for example `shotstack-itv-mini`.** This type continues to\nfunction and is internally rewritten to VideoAsset; no behaviour change for\nexisting integrations.\n\nThe ImageToVideoAsset lets you create a video from an image and a text prompt.\n",
|
|
2567
2568
|
"properties": {
|
|
2568
2569
|
"type": {
|
|
2569
2570
|
"type": "string",
|
|
@@ -4965,12 +4966,13 @@
|
|
|
4965
4966
|
"example": "basic"
|
|
4966
4967
|
},
|
|
4967
4968
|
"status": {
|
|
4968
|
-
"description": "The status of the render task. <ul>\n <li>`queued` - render is queued waiting to be rendered</li>\n <li>`fetching` - assets are being fetched</li>\n <li>`preprocessing` - video assets are being processed for compatibility</li>\n <li>`rendering` - the asset is being rendered</li>\n <li>`saving` - the final asset is being saved to storage</li>\n <li>`done` - the asset is ready to be downloaded</li>\n <li>`failed` - there was an error rendering the asset</li>\n</ul>",
|
|
4969
|
+
"description": "The status of the render task. <ul>\n <li>`queued` - render is queued waiting to be rendered</li>\n <li>`fetching` - assets are being fetched</li>\n <li>`preprocessing` - video assets are being processed for compatibility</li>\n <li>`rendering` - the asset is being rendered</li>\n <li>`generating` - AI/media generation is in progress</li>\n <li>`saving` - the final asset is being saved to storage</li>\n <li>`done` - the asset is ready to be downloaded</li>\n <li>`failed` - there was an error rendering the asset</li>\n</ul>",
|
|
4969
4970
|
"enum": [
|
|
4970
4971
|
"queued",
|
|
4971
4972
|
"fetching",
|
|
4972
4973
|
"preprocessing",
|
|
4973
4974
|
"rendering",
|
|
4975
|
+
"generating",
|
|
4974
4976
|
"saving",
|
|
4975
4977
|
"done",
|
|
4976
4978
|
"failed"
|
|
@@ -202,7 +202,8 @@
|
|
|
202
202
|
]
|
|
203
203
|
},
|
|
204
204
|
"CaptionAsset": {
|
|
205
|
-
"
|
|
205
|
+
"deprecated": true,
|
|
206
|
+
"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.",
|
|
206
207
|
"type": "object",
|
|
207
208
|
"properties": {
|
|
208
209
|
"type": {
|
|
@@ -1152,7 +1153,7 @@
|
|
|
1152
1153
|
},
|
|
1153
1154
|
"ImageToVideoAsset": {
|
|
1154
1155
|
"deprecated": true,
|
|
1155
|
-
"description": "**Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)\nwith `prompt` and `inputSrc`
|
|
1156
|
+
"description": "**Notice: ImageToVideoAsset is deprecated. Use [VideoAsset](#tocs_videoasset)\nwith `prompt`, a `model` that accepts a starting image, and that image in\n`options.inputSrc` — for example `shotstack-itv-mini`.** This type continues to\nfunction and is internally rewritten to VideoAsset; no behaviour change for\nexisting integrations.\n\nThe ImageToVideoAsset lets you create a video from an image and a text prompt.",
|
|
1156
1157
|
"properties": {
|
|
1157
1158
|
"type": {
|
|
1158
1159
|
"type": "string",
|
|
@@ -3675,7 +3676,7 @@
|
|
|
3675
3676
|
"type": "object"
|
|
3676
3677
|
},
|
|
3677
3678
|
"VideoAsset": {
|
|
3678
|
-
"description": "The VideoAsset adds a video to a Clip. The video 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 URL of an mp4 (or compatible) video file.\n- **Generated:** set `prompt` to describe the motion. Choose a generator\n with `model` and configure it with model-specific `options
|
|
3679
|
+
"description": "The VideoAsset adds a video to a Clip. The video 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 URL of an mp4 (or compatible) video file.\n- **Generated:** set `prompt` to describe the motion. Choose a generator\n with `model` and configure it with model-specific `options`. Models that\n animate a starting image take it as `options.inputSrc`; the default model\n generates from the prompt alone. The generated `src` is filled in\n automatically.\n- **Both:** `src` acts as a preview placeholder while `prompt` drives\n generation — the video is regenerated from the prompt at render time.\n Unchanged prompts and options resolve from the generation cache.",
|
|
3679
3680
|
"type": "object",
|
|
3680
3681
|
"properties": {
|
|
3681
3682
|
"type": {
|
|
@@ -3696,7 +3697,7 @@
|
|
|
3696
3697
|
]
|
|
3697
3698
|
},
|
|
3698
3699
|
"prompt": {
|
|
3699
|
-
"description": "A text prompt to generate the video from. The engine generates a video at render time and fills `src` automatically; an existing `src` is treated as a preview placeholder and replaced. Use `model` to choose the generator and `options` to configure it
|
|
3700
|
+
"description": "A text prompt to generate the video from. The engine generates a video at render time and fills `src` automatically; an existing `src` is treated as a preview placeholder and replaced. Use `model` to choose the generator and `options` to configure it. A starting image goes in `options.inputSrc`, on the models that accept one.",
|
|
3700
3701
|
"type": "string",
|
|
3701
3702
|
"maxLength": 4000,
|
|
3702
3703
|
"examples": [
|