@shotstack/schemas 1.23.2 → 1.23.4
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
CHANGED
|
@@ -4196,7 +4196,7 @@
|
|
|
4196
4196
|
"example": "mp4"
|
|
4197
4197
|
},
|
|
4198
4198
|
"resolution": {
|
|
4199
|
-
"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 @
|
|
4199
|
+
"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 @ 12fps</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>",
|
|
4200
4200
|
"enum": [
|
|
4201
4201
|
"preview",
|
|
4202
4202
|
"mobile",
|
|
@@ -4224,7 +4224,7 @@
|
|
|
4224
4224
|
"$ref": "#/components/schemas/Size"
|
|
4225
4225
|
},
|
|
4226
4226
|
"fps": {
|
|
4227
|
-
"description": "Override the default frames per second. Useful for when the source footage is recorded at 30fps, i.e. on mobile devices. Lower frame rates can be used to add cinematic quality (24fps) or to create smaller file size/faster render times or animated gifs (12 or 15fps). Default is 25fps. <ul>\n <li>`12` - 12fps</li>\n <li>`15` - 15fps</li>\n <li>`24` - 24fps</li>\n <li>`23.976` - 23.976fps</li>\n <li>`25` (default) - 25fps</li>\n <li>`29.97` - 29.97fps</li>\n <li>`30` - 30fps</li>\n <li>`48` - 48fps</li>\n <li>`50` - 50fps</li>\n <li>`59.94` - 59.94fps</li>\n <li>`60` - 60fps</li>\n</ul>",
|
|
4227
|
+
"description": "Override the default frames per second. Useful for when the source footage is recorded at 30fps, i.e. on mobile devices. Lower frame rates can be used to add cinematic quality (24fps) or to create smaller file size/faster render times or animated gifs (12 or 15fps). Default is 25fps, or 12fps for the `preview` resolution. <ul>\n <li>`12` - 12fps</li>\n <li>`15` - 15fps</li>\n <li>`24` - 24fps</li>\n <li>`23.976` - 23.976fps</li>\n <li>`25` (default) - 25fps</li>\n <li>`29.97` - 29.97fps</li>\n <li>`30` - 30fps</li>\n <li>`48` - 48fps</li>\n <li>`50` - 50fps</li>\n <li>`59.94` - 59.94fps</li>\n <li>`60` - 60fps</li>\n</ul>",
|
|
4228
4228
|
"enum": [
|
|
4229
4229
|
12,
|
|
4230
4230
|
15,
|
|
@@ -4242,7 +4242,7 @@
|
|
|
4242
4242
|
"example": 25
|
|
4243
4243
|
},
|
|
4244
4244
|
"scaleTo": {
|
|
4245
|
-
"description": "Override the resolution and scale the video or image to render at a different size. When using scaleTo the asset should be edited at the resolution dimensions, i.e. use font sizes that look best at HD, then use scaleTo to output the file at SD and the text will be scaled to the correct size. This is useful if you want to create multiple asset sizes. <ul>\n <li>`preview` - 512px x 288px
|
|
4245
|
+
"description": "Override the resolution and scale the video or image to render at a different size. When using scaleTo the asset should be edited at the resolution dimensions, i.e. use font sizes that look best at HD, then use scaleTo to output the file at SD and the text will be scaled to the correct size. This is useful if you want to create multiple asset sizes. <ul>\n <li>`preview` - 512px x 288px</li>\n <li>`mobile` - 640px x 360px</li>\n <li>`sd` - 1024px x 576px</li>\n <li>`hd` - 1280px x 720px</li>\n <li>`1080` - 1920px x 1080px</li>\n</ul>",
|
|
4246
4246
|
"enum": [
|
|
4247
4247
|
"preview",
|
|
4248
4248
|
"mobile",
|
|
@@ -4563,7 +4563,7 @@
|
|
|
4563
4563
|
"example": "shotstack"
|
|
4564
4564
|
},
|
|
4565
4565
|
"exclude": {
|
|
4566
|
-
"description": "Set to `true` to [opt-out](https://shotstack.io/docs/guide/serving-assets/self-host/) from the Shotstack hosting and CDN service.
|
|
4566
|
+
"description": "Set to `true` to [opt-out](https://shotstack.io/docs/guide/serving-assets/self-host/) from the Shotstack hosting and CDN service. By default files are hosted and stay until you delete them. If you opt out, the file is not hosted and must be downloaded from the render status `url` within 24 hours of rendering.",
|
|
4567
4567
|
"type": "boolean",
|
|
4568
4568
|
"example": false
|
|
4569
4569
|
}
|
|
@@ -5509,7 +5509,7 @@
|
|
|
5509
5509
|
"example": 9433.44
|
|
5510
5510
|
},
|
|
5511
5511
|
"url": {
|
|
5512
|
-
"description": "
|
|
5512
|
+
"description": "A temporary download link to the final asset. This will only be available if status is done. By default all assets are also copied to the [Shotstack hosting and CDN](https://shotstack.io/docs/guide/serving-assets/hosting/) destination, where they stay until you delete them. Serve the asset to your users from its CDN URL, `https://cdn.shotstack.io/au/{version}/{owner}/{id}.{format}`, not from this link, which expires after 24 hours.",
|
|
5513
5513
|
"type": "string",
|
|
5514
5514
|
"example": "https://shotstack-api-v1-output.s3-ap-southeast-2.amazonaws.com/5ca6hu7s9k/2abd5c11-0f3d-4c6d-ba20-235fc9b8e8b7.mp4"
|
|
5515
5515
|
},
|
|
@@ -1385,7 +1385,7 @@
|
|
|
1385
1385
|
]
|
|
1386
1386
|
},
|
|
1387
1387
|
"resolution": {
|
|
1388
|
-
"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`.\n\n- `preview` - 512px x 288px @
|
|
1388
|
+
"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`.\n\n- `preview` - 512px x 288px @ 12fps\n\n- `mobile` - 640px x 360px @ 25fps\n\n- `sd` - 1024px x 576px @ 25fps\n\n- `hd` - 1280px x 720px @ 25fps\n\n- `1080` - 1920px x 1080px @ 25fps\n\n- `4k` - 3840px x 2160px @ 25fps",
|
|
1389
1389
|
"enum": [
|
|
1390
1390
|
"preview",
|
|
1391
1391
|
"mobile",
|
|
@@ -1417,7 +1417,7 @@
|
|
|
1417
1417
|
"$ref": "#/$defs/Size"
|
|
1418
1418
|
},
|
|
1419
1419
|
"fps": {
|
|
1420
|
-
"description": "Override the default frames per second. Useful for when the source footage is recorded at 30fps, i.e. on mobile devices. Lower frame rates can be used to add cinematic quality (24fps) or to create smaller file size/faster render times or animated gifs (12 or 15fps). Default is 25fps.\n\n- `12` - 12fps\n\n- `15` - 15fps\n\n- `24` - 24fps\n\n- `23.976` - 23.976fps\n\n- `25` (default) - 25fps\n\n- `29.97` - 29.97fps\n\n- `30` - 30fps\n\n- `48` - 48fps\n\n- `50` - 50fps\n\n- `59.94` - 59.94fps\n\n- `60` - 60fps",
|
|
1420
|
+
"description": "Override the default frames per second. Useful for when the source footage is recorded at 30fps, i.e. on mobile devices. Lower frame rates can be used to add cinematic quality (24fps) or to create smaller file size/faster render times or animated gifs (12 or 15fps). Default is 25fps, or 12fps for the `preview` resolution.\n\n- `12` - 12fps\n\n- `15` - 15fps\n\n- `24` - 24fps\n\n- `23.976` - 23.976fps\n\n- `25` (default) - 25fps\n\n- `29.97` - 29.97fps\n\n- `30` - 30fps\n\n- `48` - 48fps\n\n- `50` - 50fps\n\n- `59.94` - 59.94fps\n\n- `60` - 60fps",
|
|
1421
1421
|
"enum": [
|
|
1422
1422
|
12,
|
|
1423
1423
|
15,
|
|
@@ -1437,7 +1437,7 @@
|
|
|
1437
1437
|
]
|
|
1438
1438
|
},
|
|
1439
1439
|
"scaleTo": {
|
|
1440
|
-
"description": "Override the resolution and scale the video or image to render at a different size. When using scaleTo the asset should be edited at the resolution dimensions, i.e. use font sizes that look best at HD, then use scaleTo to output the file at SD and the text will be scaled to the correct size. This is useful if you want to create multiple asset sizes.\n\n- `preview` - 512px x 288px
|
|
1440
|
+
"description": "Override the resolution and scale the video or image to render at a different size. When using scaleTo the asset should be edited at the resolution dimensions, i.e. use font sizes that look best at HD, then use scaleTo to output the file at SD and the text will be scaled to the correct size. This is useful if you want to create multiple asset sizes.\n\n- `preview` - 512px x 288px\n\n- `mobile` - 640px x 360px\n\n- `sd` - 1024px x 576px\n\n- `hd` - 1280px x 720px\n\n- `1080` - 1920px x 1080px",
|
|
1441
1441
|
"enum": [
|
|
1442
1442
|
"preview",
|
|
1443
1443
|
"mobile",
|
|
@@ -2747,7 +2747,7 @@
|
|
|
2747
2747
|
]
|
|
2748
2748
|
},
|
|
2749
2749
|
"exclude": {
|
|
2750
|
-
"description": "Set to `true` to [opt-out](https://shotstack.io/docs/guide/serving-assets/self-host/) from the Shotstack hosting and CDN service.
|
|
2750
|
+
"description": "Set to `true` to [opt-out](https://shotstack.io/docs/guide/serving-assets/self-host/) from the Shotstack hosting and CDN service. By default files are hosted and stay until you delete them. If you opt out, the file is not hosted and must be downloaded from the render status `url` within 24 hours of rendering.",
|
|
2751
2751
|
"type": "boolean",
|
|
2752
2752
|
"examples": [
|
|
2753
2753
|
false
|