@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/schema.d.ts
CHANGED
|
@@ -2342,7 +2342,7 @@ export interface components {
|
|
|
2342
2342
|
format: "mp4" | "gif" | "mp3" | "jpg" | "png" | "bmp";
|
|
2343
2343
|
/**
|
|
2344
2344
|
* @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>
|
|
2345
|
-
* <li>`preview` - 512px x 288px @
|
|
2345
|
+
* <li>`preview` - 512px x 288px @ 12fps</li>
|
|
2346
2346
|
* <li>`mobile` - 640px x 360px @ 25fps</li>
|
|
2347
2347
|
* <li>`sd` - 1024px x 576px @ 25fps</li>
|
|
2348
2348
|
* <li>`hd` - 1280px x 720px @ 25fps</li>
|
|
@@ -2367,7 +2367,7 @@ export interface components {
|
|
|
2367
2367
|
aspectRatio?: "16:9" | "9:16" | "1:1" | "4:5" | "4:3";
|
|
2368
2368
|
size?: components["schemas"]["Size"];
|
|
2369
2369
|
/**
|
|
2370
|
-
* @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>
|
|
2370
|
+
* @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>
|
|
2371
2371
|
* <li>`12` - 12fps</li>
|
|
2372
2372
|
* <li>`15` - 15fps</li>
|
|
2373
2373
|
* <li>`24` - 24fps</li>
|
|
@@ -2386,11 +2386,11 @@ export interface components {
|
|
|
2386
2386
|
fps?: 12 | 15 | 23.976 | 24 | 25 | 29.97 | 30 | 48 | 50 | 59.94 | 60;
|
|
2387
2387
|
/**
|
|
2388
2388
|
* @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>
|
|
2389
|
-
* <li>`preview` - 512px x 288px
|
|
2390
|
-
* <li>`mobile` - 640px x 360px
|
|
2391
|
-
* <li>`sd` - 1024px x 576px
|
|
2392
|
-
* <li>`hd` - 1280px x 720px
|
|
2393
|
-
* <li>`1080` - 1920px x 1080px
|
|
2389
|
+
* <li>`preview` - 512px x 288px</li>
|
|
2390
|
+
* <li>`mobile` - 640px x 360px</li>
|
|
2391
|
+
* <li>`sd` - 1024px x 576px</li>
|
|
2392
|
+
* <li>`hd` - 1280px x 720px</li>
|
|
2393
|
+
* <li>`1080` - 1920px x 1080px</li>
|
|
2394
2394
|
* </ul>
|
|
2395
2395
|
* @enum {string}
|
|
2396
2396
|
*/
|
|
@@ -2589,7 +2589,7 @@ export interface components {
|
|
|
2589
2589
|
*/
|
|
2590
2590
|
provider: string;
|
|
2591
2591
|
/**
|
|
2592
|
-
* @description Set to `true` to [opt-out](https://shotstack.io/docs/guide/serving-assets/self-host/) from the Shotstack hosting and CDN service.
|
|
2592
|
+
* @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.
|
|
2593
2593
|
* @example false
|
|
2594
2594
|
*/
|
|
2595
2595
|
exclude?: boolean;
|
|
@@ -3246,7 +3246,7 @@ export interface components {
|
|
|
3246
3246
|
*/
|
|
3247
3247
|
renderTime?: number;
|
|
3248
3248
|
/**
|
|
3249
|
-
* @description
|
|
3249
|
+
* @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.
|
|
3250
3250
|
* @example https://shotstack-api-v1-output.s3-ap-southeast-2.amazonaws.com/5ca6hu7s9k/2abd5c11-0f3d-4c6d-ba20-235fc9b8e8b7.mp4
|
|
3251
3251
|
*/
|
|
3252
3252
|
url?: string;
|