@shotstack/schemas 1.1.2 → 1.3.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 +240 -20
- package/dist/schema.d.ts +169 -19
- package/dist/zod/zod.gen.cjs +80 -14
- package/dist/zod/zod.gen.d.ts +1407 -60
- package/dist/zod/zod.gen.js +75 -9
- package/dist/zod/zod.gen.ts +91 -9
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -513,10 +513,20 @@ export interface components {
|
|
|
513
513
|
*/
|
|
514
514
|
fit?: "cover" | "contain" | "crop" | "none";
|
|
515
515
|
/**
|
|
516
|
-
* @description Scale the asset to a fraction of the viewport size - i.e. setting the scale to 0.5 will scale asset to half the size of the viewport. This is useful for picture-in-picture video and
|
|
516
|
+
* @description Scale the asset to a fraction of the viewport size - i.e. setting the scale to 0.5 will scale asset to half the size of the viewport. This is useful for picture-in-picture video and scaling images such as logos and watermarks.
|
|
517
517
|
* @example 0
|
|
518
518
|
*/
|
|
519
519
|
scale?: number;
|
|
520
|
+
/**
|
|
521
|
+
* @description Set the width of the clip bounding box in pixels. This constrains the width of the clip, overriding the default behavior where clips fill the viewport width.
|
|
522
|
+
* @example 800
|
|
523
|
+
*/
|
|
524
|
+
width?: number;
|
|
525
|
+
/**
|
|
526
|
+
* @description Set the height of the clip bounding box in pixels. This constrains the height of the clip, overriding the default behavior where clips fill the viewport height.
|
|
527
|
+
* @example 600
|
|
528
|
+
*/
|
|
529
|
+
height?: number;
|
|
520
530
|
/**
|
|
521
531
|
* @description Place the asset in one of nine predefined positions of the viewport. This is most effective for when the asset is scaled and you want to position the element to a specific position. <ul>
|
|
522
532
|
* <li>`top` - top (center)</li>
|
|
@@ -566,6 +576,11 @@ export interface components {
|
|
|
566
576
|
opacity?: number | components["schemas"]["Tween"][];
|
|
567
577
|
/** @description A transformation lets you modify the visual properties of a clip. Available transformations are <b>rotate</b>, <b>skew</b> and <b>flip</b>. Transformations can be combined to create interesting new shapes and effects. */
|
|
568
578
|
transform?: components["schemas"]["Transformation"];
|
|
579
|
+
/**
|
|
580
|
+
* @description A unique identifier for this clip that can be used to reference it from other clips using the `alias://` protocol in asset sources. This is useful for features like auto-captioning where a caption asset needs to reference the audio from another clip.
|
|
581
|
+
* @example MY_VIDEO_CLIP
|
|
582
|
+
*/
|
|
583
|
+
alias?: string;
|
|
569
584
|
};
|
|
570
585
|
/** @description The type of asset to display for the duration of the Clip, i.e. a video clip or an image. Choose from one of the available asset types below. */
|
|
571
586
|
Asset: components["schemas"]["VideoAsset"] | components["schemas"]["ImageAsset"] | components["schemas"]["TextAsset"] | components["schemas"]["RichTextAsset"] | components["schemas"]["AudioAsset"] | components["schemas"]["LumaAsset"] | components["schemas"]["CaptionAsset"] | components["schemas"]["HtmlAsset"] | components["schemas"]["TitleAsset"] | components["schemas"]["ShapeAsset"] | components["schemas"]["TextToImageAsset"] | components["schemas"]["ImageToVideoAsset"];
|
|
@@ -602,7 +617,7 @@ export interface components {
|
|
|
602
617
|
* </ul>
|
|
603
618
|
* @enum {string}
|
|
604
619
|
*/
|
|
605
|
-
volumeEffect?: "fadeIn" | "fadeOut" | "fadeInFadeOut";
|
|
620
|
+
volumeEffect?: "none" | "fadeIn" | "fadeOut" | "fadeInFadeOut";
|
|
606
621
|
/**
|
|
607
622
|
* Format: float
|
|
608
623
|
* @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).
|
|
@@ -667,6 +682,40 @@ export interface components {
|
|
|
667
682
|
background?: components["schemas"]["TextBackground"];
|
|
668
683
|
/** @description Alignment properties. */
|
|
669
684
|
alignment?: components["schemas"]["TextAlignment"];
|
|
685
|
+
/** @description Text stroke (outline) properties. */
|
|
686
|
+
stroke?: {
|
|
687
|
+
/**
|
|
688
|
+
* @description The width of the stroke in pixels.
|
|
689
|
+
* @example 2
|
|
690
|
+
*/
|
|
691
|
+
width?: number;
|
|
692
|
+
/**
|
|
693
|
+
* @description The stroke color using hexadecimal color notation.
|
|
694
|
+
* @example #000000
|
|
695
|
+
*/
|
|
696
|
+
color?: string;
|
|
697
|
+
};
|
|
698
|
+
/** @description Animation properties for text entrance effects. */
|
|
699
|
+
animation?: {
|
|
700
|
+
/**
|
|
701
|
+
* @description The animation preset to apply. <ul>
|
|
702
|
+
* <li>`typewriter` - typewriter effect where characters appear one at a time</li>
|
|
703
|
+
* </ul>
|
|
704
|
+
* @example typewriter
|
|
705
|
+
* @enum {string}
|
|
706
|
+
*/
|
|
707
|
+
preset: "typewriter";
|
|
708
|
+
/**
|
|
709
|
+
* @description The duration of the animation in seconds.
|
|
710
|
+
* @example 2
|
|
711
|
+
*/
|
|
712
|
+
duration?: number;
|
|
713
|
+
};
|
|
714
|
+
/**
|
|
715
|
+
* @description The string to display when text overflows its bounding box. Set to an ellipsis character or custom string to indicate truncated text.
|
|
716
|
+
* @example ...
|
|
717
|
+
*/
|
|
718
|
+
ellipsis?: string;
|
|
670
719
|
/**
|
|
671
720
|
* @description discriminator enum property added by openapi-typescript
|
|
672
721
|
* @enum {string}
|
|
@@ -688,16 +737,6 @@ export interface components {
|
|
|
688
737
|
* @example Hello World
|
|
689
738
|
*/
|
|
690
739
|
text: string;
|
|
691
|
-
/**
|
|
692
|
-
* @description Set the width of the rich text asset bounding box in pixels. Text will wrap to fill the bounding box. Minimum 1px, maximum 4096px.
|
|
693
|
-
* @example 800
|
|
694
|
-
*/
|
|
695
|
-
width?: number;
|
|
696
|
-
/**
|
|
697
|
-
* @description Set the height of the rich text asset bounding box in pixels. Text and elements will be masked if they exceed the height of the bounding box. Minimum 1px, maximum 4096px.
|
|
698
|
-
* @example 600
|
|
699
|
-
*/
|
|
700
|
-
height?: number;
|
|
701
740
|
/** @description Font styling properties. */
|
|
702
741
|
font?: components["schemas"]["RichTextFont"];
|
|
703
742
|
/** @description Text style properties including spacing, line height, and transformations. */
|
|
@@ -708,6 +747,60 @@ export interface components {
|
|
|
708
747
|
shadow?: components["schemas"]["RichTextShadow"];
|
|
709
748
|
/** @description Background styling properties for the text bounding box. */
|
|
710
749
|
background?: components["schemas"]["RichTextBackground"];
|
|
750
|
+
/** @description Border styling properties for the text bounding box. */
|
|
751
|
+
border?: {
|
|
752
|
+
/**
|
|
753
|
+
* @description The width of the border in pixels. Must be 0 or greater.
|
|
754
|
+
* @default 0
|
|
755
|
+
* @example 2
|
|
756
|
+
*/
|
|
757
|
+
width: number;
|
|
758
|
+
/**
|
|
759
|
+
* @description The border color using hexadecimal color notation.
|
|
760
|
+
* @default #000000
|
|
761
|
+
* @example #ff0000
|
|
762
|
+
*/
|
|
763
|
+
color: string;
|
|
764
|
+
/**
|
|
765
|
+
* @description The opacity of the border where 1 is opaque and 0 is transparent.
|
|
766
|
+
* @default 1
|
|
767
|
+
* @example 0.8
|
|
768
|
+
*/
|
|
769
|
+
opacity: number;
|
|
770
|
+
/**
|
|
771
|
+
* @description The border radius in pixels for rounded corners. Must be 0 or greater.
|
|
772
|
+
* @default 0
|
|
773
|
+
* @example 10
|
|
774
|
+
*/
|
|
775
|
+
radius: number;
|
|
776
|
+
};
|
|
777
|
+
/** @description Padding inside the text bounding box. Can be a single number (applied to all sides) or an object with individual sides. */
|
|
778
|
+
padding?: number | {
|
|
779
|
+
/**
|
|
780
|
+
* @description Top padding in pixels.
|
|
781
|
+
* @default 0
|
|
782
|
+
* @example 10
|
|
783
|
+
*/
|
|
784
|
+
top: number;
|
|
785
|
+
/**
|
|
786
|
+
* @description Right padding in pixels.
|
|
787
|
+
* @default 0
|
|
788
|
+
* @example 10
|
|
789
|
+
*/
|
|
790
|
+
right: number;
|
|
791
|
+
/**
|
|
792
|
+
* @description Bottom padding in pixels.
|
|
793
|
+
* @default 0
|
|
794
|
+
* @example 10
|
|
795
|
+
*/
|
|
796
|
+
bottom: number;
|
|
797
|
+
/**
|
|
798
|
+
* @description Left padding in pixels.
|
|
799
|
+
* @default 0
|
|
800
|
+
* @example 10
|
|
801
|
+
*/
|
|
802
|
+
left: number;
|
|
803
|
+
};
|
|
711
804
|
/** @description Text alignment properties (horizontal and vertical). */
|
|
712
805
|
align?: components["schemas"]["RichTextAlignment"];
|
|
713
806
|
/** @description Animation properties for text entrance effects. */
|
|
@@ -748,7 +841,7 @@ export interface components {
|
|
|
748
841
|
* </ul>
|
|
749
842
|
* @enum {string}
|
|
750
843
|
*/
|
|
751
|
-
effect?: "fadeIn" | "fadeOut" | "fadeInFadeOut";
|
|
844
|
+
effect?: "none" | "fadeIn" | "fadeOut" | "fadeInFadeOut";
|
|
752
845
|
/**
|
|
753
846
|
* @description discriminator enum property added by openapi-typescript
|
|
754
847
|
* @enum {string}
|
|
@@ -1136,7 +1229,7 @@ export interface components {
|
|
|
1136
1229
|
* The transition speed can also be controlled by appending `Fast` or `Slow` to the transition, e.g. `fadeFast` or `CarouselLeftSlow`.
|
|
1137
1230
|
* @enum {string}
|
|
1138
1231
|
*/
|
|
1139
|
-
in?: "fade" | "fadeSlow" | "fadeFast" | "reveal" | "revealSlow" | "revealFast" | "wipeLeft" | "wipeLeftSlow" | "wipeLeftFast" | "wipeRight" | "wipeRightSlow" | "wipeRightFast" | "slideLeft" | "slideLeftSlow" | "slideLeftFast" | "slideRight" | "slideRightSlow" | "slideRightFast" | "slideUp" | "slideUpSlow" | "slideUpFast" | "slideDown" | "slideDownSlow" | "slideDownFast" | "carouselLeft" | "carouselLeftSlow" | "carouselLeftFast" | "carouselRight" | "carouselRightSlow" | "carouselRightFast" | "carouselUp" | "carouselUpSlow" | "carouselUpFast" | "carouselDown" | "carouselDownSlow" | "carouselDownFast" | "shuffleTopRight" | "shuffleTopRightSlow" | "shuffleTopRightFast" | "shuffleRightTop" | "shuffleRightTopSlow" | "shuffleRightTopFast" | "shuffleRightBottom" | "shuffleRightBottomSlow" | "shuffleRightBottomFast" | "shuffleBottomRight" | "shuffleBottomRightSlow" | "shuffleBottomRightFast" | "shuffleBottomLeft" | "shuffleBottomLeftSlow" | "shuffleBottomLeftFast" | "shuffleLeftBottom" | "shuffleLeftBottomSlow" | "shuffleLeftBottomFast" | "shuffleLeftTop" | "shuffleLeftTopSlow" | "shuffleLeftTopFast" | "shuffleTopLeft" | "shuffleTopLeftSlow" | "shuffleTopLeftFast" | "zoom";
|
|
1232
|
+
in?: "none" | "fade" | "fadeSlow" | "fadeFast" | "reveal" | "revealSlow" | "revealFast" | "wipeLeft" | "wipeLeftSlow" | "wipeLeftFast" | "wipeRight" | "wipeRightSlow" | "wipeRightFast" | "slideLeft" | "slideLeftSlow" | "slideLeftFast" | "slideRight" | "slideRightSlow" | "slideRightFast" | "slideUp" | "slideUpSlow" | "slideUpFast" | "slideDown" | "slideDownSlow" | "slideDownFast" | "carouselLeft" | "carouselLeftSlow" | "carouselLeftFast" | "carouselRight" | "carouselRightSlow" | "carouselRightFast" | "carouselUp" | "carouselUpSlow" | "carouselUpFast" | "carouselDown" | "carouselDownSlow" | "carouselDownFast" | "shuffleTopRight" | "shuffleTopRightSlow" | "shuffleTopRightFast" | "shuffleRightTop" | "shuffleRightTopSlow" | "shuffleRightTopFast" | "shuffleRightBottom" | "shuffleRightBottomSlow" | "shuffleRightBottomFast" | "shuffleBottomRight" | "shuffleBottomRightSlow" | "shuffleBottomRightFast" | "shuffleBottomLeft" | "shuffleBottomLeftSlow" | "shuffleBottomLeftFast" | "shuffleLeftBottom" | "shuffleLeftBottomSlow" | "shuffleLeftBottomFast" | "shuffleLeftTop" | "shuffleLeftTopSlow" | "shuffleLeftTopFast" | "shuffleTopLeft" | "shuffleTopLeftSlow" | "shuffleTopLeftFast" | "zoom";
|
|
1140
1233
|
/**
|
|
1141
1234
|
* @description The transition out. Available transitions are:
|
|
1142
1235
|
* <ul>
|
|
@@ -1165,7 +1258,7 @@ export interface components {
|
|
|
1165
1258
|
* The transition speed can also be controlled by appending `Fast` or `Slow` to the transition, e.g. `fadeFast` or `CarouselLeftSlow`.
|
|
1166
1259
|
* @enum {string}
|
|
1167
1260
|
*/
|
|
1168
|
-
out?: "fade" | "fadeSlow" | "fadeFast" | "reveal" | "revealSlow" | "revealFast" | "wipeLeft" | "wipeLeftSlow" | "wipeLeftFast" | "wipeRight" | "wipeRightSlow" | "wipeRightFast" | "slideLeft" | "slideLeftSlow" | "slideLeftFast" | "slideRight" | "slideRightSlow" | "slideRightFast" | "slideUp" | "slideUpSlow" | "slideUpFast" | "slideDown" | "slideDownSlow" | "slideDownFast" | "carouselLeft" | "carouselLeftSlow" | "carouselLeftFast" | "carouselRight" | "carouselRightSlow" | "carouselRightFast" | "carouselUp" | "carouselUpSlow" | "carouselUpFast" | "carouselDown" | "carouselDownSlow" | "carouselDownFast" | "shuffleTopRight" | "shuffleTopRightSlow" | "shuffleTopRightFast" | "shuffleRightTop" | "shuffleRightTopSlow" | "shuffleRightTopFast" | "shuffleRightBottom" | "shuffleRightBottomSlow" | "shuffleRightBottomFast" | "shuffleBottomRight" | "shuffleBottomRightSlow" | "shuffleBottomRightFast" | "shuffleBottomLeft" | "shuffleBottomLeftSlow" | "shuffleBottomLeftFast" | "shuffleLeftBottom" | "shuffleLeftBottomSlow" | "shuffleLeftBottomFast" | "shuffleLeftTop" | "shuffleLeftTopSlow" | "shuffleLeftTopFast" | "shuffleTopLeft" | "shuffleTopLeftSlow" | "shuffleTopLeftFast" | "zoom";
|
|
1261
|
+
out?: "none" | "fade" | "fadeSlow" | "fadeFast" | "reveal" | "revealSlow" | "revealFast" | "wipeLeft" | "wipeLeftSlow" | "wipeLeftFast" | "wipeRight" | "wipeRightSlow" | "wipeRightFast" | "slideLeft" | "slideLeftSlow" | "slideLeftFast" | "slideRight" | "slideRightSlow" | "slideRightFast" | "slideUp" | "slideUpSlow" | "slideUpFast" | "slideDown" | "slideDownSlow" | "slideDownFast" | "carouselLeft" | "carouselLeftSlow" | "carouselLeftFast" | "carouselRight" | "carouselRightSlow" | "carouselRightFast" | "carouselUp" | "carouselUpSlow" | "carouselUpFast" | "carouselDown" | "carouselDownSlow" | "carouselDownFast" | "shuffleTopRight" | "shuffleTopRightSlow" | "shuffleTopRightFast" | "shuffleRightTop" | "shuffleRightTopSlow" | "shuffleRightTopFast" | "shuffleRightBottom" | "shuffleRightBottomSlow" | "shuffleRightBottomFast" | "shuffleBottomRight" | "shuffleBottomRightSlow" | "shuffleBottomRightFast" | "shuffleBottomLeft" | "shuffleBottomLeftSlow" | "shuffleBottomLeftFast" | "shuffleLeftBottom" | "shuffleLeftBottomSlow" | "shuffleLeftBottomFast" | "shuffleLeftTop" | "shuffleLeftTopSlow" | "shuffleLeftTopFast" | "shuffleTopLeft" | "shuffleTopLeftSlow" | "shuffleTopLeftFast" | "zoom";
|
|
1169
1262
|
};
|
|
1170
1263
|
/** @description Offsets the position of an asset horizontally or vertically by a relative distance. */
|
|
1171
1264
|
Offset: {
|
|
@@ -1210,7 +1303,7 @@ export interface components {
|
|
|
1210
1303
|
/** @description Rotate a clip by the specified angle in degrees. Use a number or an array of [Tween](./#tocs_tween) objects to create a custom animation. */
|
|
1211
1304
|
angle?: number | components["schemas"]["Tween"][];
|
|
1212
1305
|
};
|
|
1213
|
-
/** @description Skew a clip so its edges are sheared at an angle. Use values between
|
|
1306
|
+
/** @description Skew a clip so its edges are sheared at an angle. Use values between -100 and 100. Values over 3 or under -3 will skew the clip almost flat. */
|
|
1214
1307
|
SkewTransformation: {
|
|
1215
1308
|
/** @description Skew the clip along it's x axis. */
|
|
1216
1309
|
x?: number | components["schemas"]["Tween"][];
|
|
@@ -1270,6 +1363,21 @@ export interface components {
|
|
|
1270
1363
|
* @example #000000
|
|
1271
1364
|
*/
|
|
1272
1365
|
color?: string;
|
|
1366
|
+
/**
|
|
1367
|
+
* @description The opacity of the background where 1 is opaque and 0 is transparent.
|
|
1368
|
+
* @example 0.8
|
|
1369
|
+
*/
|
|
1370
|
+
opacity?: number;
|
|
1371
|
+
/**
|
|
1372
|
+
* @description Padding inside the background box in pixels.
|
|
1373
|
+
* @example 10
|
|
1374
|
+
*/
|
|
1375
|
+
padding?: number;
|
|
1376
|
+
/**
|
|
1377
|
+
* @description The border radius of the background box in pixels for rounded corners.
|
|
1378
|
+
* @example 5
|
|
1379
|
+
*/
|
|
1380
|
+
borderRadius?: number;
|
|
1273
1381
|
};
|
|
1274
1382
|
/** @description Horizontal and vertical alignment properties for text. */
|
|
1275
1383
|
TextAlignment: {
|
|
@@ -1297,7 +1405,7 @@ export interface components {
|
|
|
1297
1405
|
/** @description Font properties for rich text. */
|
|
1298
1406
|
RichTextFont: {
|
|
1299
1407
|
/**
|
|
1300
|
-
* @description The font family name. This must be the Family name embedded in the font, i.e. "Open Sans".
|
|
1408
|
+
* @description The font family name. This must be the Family name embedded in the font, i.e. "Open Sans".
|
|
1301
1409
|
* @default Open Sans
|
|
1302
1410
|
* @example Open Sans
|
|
1303
1411
|
*/
|
|
@@ -1754,7 +1862,7 @@ export interface components {
|
|
|
1754
1862
|
* </ul>
|
|
1755
1863
|
* @enum {string}
|
|
1756
1864
|
*/
|
|
1757
|
-
scaleTo?: "preview" | "mobile" | "sd" | "hd" | "1080";
|
|
1865
|
+
scaleTo?: "preview" | "mobile" | "sd" | "hd" | "1080" | "4k";
|
|
1758
1866
|
/**
|
|
1759
1867
|
* @description Adjust the output quality of the video, image or audio. Adjusting quality affects render speed, download speeds and storage requirements due to file size. The default `medium` provides the most optimized choice for all three factors. <ul>
|
|
1760
1868
|
* <li>`verylow` - reduced quality, smallest file size</li>
|
|
@@ -1839,7 +1947,44 @@ export interface components {
|
|
|
1839
1947
|
*
|
|
1840
1948
|
* By default all ingested and generated assets are automatically sent to the [Shotstack hosting destination](https://shotstack.io/docs/guide/serving-assets/hosting/). You can [opt-out](https://shotstack.io/docs/guide/serving-assets/self-host/) from by setting the Shotstack destination **exclude** property to **true**.
|
|
1841
1949
|
*/
|
|
1842
|
-
Destinations: components["schemas"]["ShotstackDestination"] | components["schemas"]["MuxDestination"] | components["schemas"]["S3Destination"] | components["schemas"]["GoogleCloudStorageDestination"] | components["schemas"]["GoogleDriveDestination"] | components["schemas"]["VimeoDestination"]
|
|
1950
|
+
Destinations: components["schemas"]["ShotstackDestination"] | components["schemas"]["MuxDestination"] | components["schemas"]["S3Destination"] | components["schemas"]["GoogleCloudStorageDestination"] | components["schemas"]["GoogleDriveDestination"] | components["schemas"]["VimeoDestination"] | {
|
|
1951
|
+
/**
|
|
1952
|
+
* @description The destination to send video to - set to `tiktok` for TikTok.
|
|
1953
|
+
* @default tiktok
|
|
1954
|
+
* @example tiktok
|
|
1955
|
+
*/
|
|
1956
|
+
provider: string;
|
|
1957
|
+
/** @description Additional TikTok configuration options. */
|
|
1958
|
+
options?: {
|
|
1959
|
+
/** @description A title for the video that will be displayed on TikTok. */
|
|
1960
|
+
title?: string;
|
|
1961
|
+
/**
|
|
1962
|
+
* @description The privacy level for the video. Options are: <ul>
|
|
1963
|
+
* <li>`public` - video is visible to everyone</li>
|
|
1964
|
+
* <li>`friends` - video is visible to friends only</li>
|
|
1965
|
+
* <li>`private` - video is only visible to you</li>
|
|
1966
|
+
* </ul>
|
|
1967
|
+
* @default private
|
|
1968
|
+
* @enum {string}
|
|
1969
|
+
*/
|
|
1970
|
+
privacyLevel: "public" | "friends" | "private";
|
|
1971
|
+
/**
|
|
1972
|
+
* @description Disable the Duet feature for this video.
|
|
1973
|
+
* @default false
|
|
1974
|
+
*/
|
|
1975
|
+
disableDuet: boolean;
|
|
1976
|
+
/**
|
|
1977
|
+
* @description Disable the Stitch feature for this video.
|
|
1978
|
+
* @default false
|
|
1979
|
+
*/
|
|
1980
|
+
disableStitch: boolean;
|
|
1981
|
+
/**
|
|
1982
|
+
* @description Disable comments on this video.
|
|
1983
|
+
* @default false
|
|
1984
|
+
*/
|
|
1985
|
+
disableComment: boolean;
|
|
1986
|
+
};
|
|
1987
|
+
};
|
|
1843
1988
|
/** @description Send videos and assets to the [Shotstack hosting and CDN](https://shotstack.io/docs/guide/serving-assets/destinations/shotstack/) service. This destination is enabled by default. */
|
|
1844
1989
|
ShotstackDestination: {
|
|
1845
1990
|
/**
|
|
@@ -1983,6 +2128,11 @@ export interface components {
|
|
|
1983
2128
|
description?: string;
|
|
1984
2129
|
/** @description Options to control the visibility of videos and privacy features. */
|
|
1985
2130
|
privacy?: components["schemas"]["VimeoDestinationPrivacyOptions"];
|
|
2131
|
+
/**
|
|
2132
|
+
* @description The Vimeo folder URI to upload the video to. The folder must already exist in your Vimeo account.
|
|
2133
|
+
* @example /users/12345678/projects/87654321
|
|
2134
|
+
*/
|
|
2135
|
+
folderUri?: string;
|
|
1986
2136
|
};
|
|
1987
2137
|
/** @description Options to control the visibility of videos and privacy features. */
|
|
1988
2138
|
VimeoDestinationPrivacyOptions: {
|
package/dist/zod/zod.gen.cjs
CHANGED
|
@@ -3,11 +3,11 @@
|
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.openAiGeneratedAssetSchema = exports.openaiGeneratedAssetOpenAiGeneratedAssetSchema = exports.openAiGeneratedAssetOptionsSchema = exports.openaiGeneratedAssetOptionsOpenAiGeneratedAssetOptionsSchema = exports.openAiTextGeneratorOptionsSchema = exports.openaiTextGeneratorOptionsOpenAiTextGeneratorOptionsSchema = exports.heyGenGeneratedAssetSchema = exports.heygenGeneratedAssetHeyGenGeneratedAssetSchema = exports.heyGenGeneratedAssetOptionsSchema = exports.heygenGeneratedAssetOptionsHeyGenGeneratedAssetOptionsSchema = exports.heyGenTextToAvatarOptionsSchema = exports.heygenTextToAvatarOptionsHeyGenTextToAvatarOptionsSchema = exports.elevenLabsGeneratedAssetSchema = exports.elevenlabsGeneratedAssetElevenLabsGeneratedAssetSchema = exports.elevenLabsGeneratedAssetOptionsSchema = exports.elevenlabsGeneratedAssetOptionsElevenLabsGeneratedAssetOptionsSchema = exports.elevenLabsTextToSpeechOptionsSchema = exports.elevenlabsTextToSpeechOptionsElevenLabsTextToSpeechOptionsSchema = exports.didGeneratedAssetSchema = exports.didGeneratedAssetDidGeneratedAssetSchema = exports.didGeneratedAssetOptionsSchema = exports.didGeneratedAssetOptionsDidGeneratedAssetOptionsSchema = exports.didTextToAvatarOptionsSchema = exports.didTextToAvatarOptionsDidTextToAvatarOptionsSchema = exports.chromaKeySchema = exports.chromakeyChromaKeySchema = exports.captionAssetSchema = exports.captionassetCaptionAssetSchema = exports.captionMarginSchema = exports.captionpropertiesCaptionMarginSchema = exports.captionFontSchema = exports.captionpropertiesCaptionFontSchema = exports.captionBackgroundSchema = exports.captionpropertiesCaptionBackgroundSchema = exports.uploadRootSchema = exports.templatesrenderRootSchema = exports.templatesidRootSchema = exports.templatesRootSchema = exports.sourcesidRootSchema = exports.sourcesRootSchema = exports.renderidRootSchema = exports.renderRootSchema = exports.probeRootSchema = exports.generateassetidRootSchema = exports.generateassetRootSchema = exports.assetsrenderidRootSchema = exports.assetsidRootSchema = exports.assetsRootSchema = exports.sourceRootSchema = exports.editRootSchema = void 0;
|
|
5
5
|
exports.shotstackDestinationSchema = exports.shotstackDestinationShotstackDestinationSchema = exports.s3DestinationSchema = exports.s3DestinationS3DestinationSchema = exports.s3DestinationOptionsSchema = exports.s3DestinationOptionsS3DestinationOptionsSchema = exports.muxDestinationSchema = exports.muxDestinationMuxDestinationSchema = exports.muxDestinationOptionsSchema = exports.muxDestinationOptionsMuxDestinationOptionsSchema = exports.googleDriveDestinationSchema = exports.googleDriveDestinationGoogleDriveDestinationSchema = exports.googleDriveDestinationOptionsSchema = exports.googleDriveDestinationOptionsGoogleDriveDestinationOptionsSchema = exports.googleCloudStorageDestinationSchema = exports.googleCloudStorageDestinationGoogleCloudStorageDestinationSchema = exports.googleCloudStorageDestinationOptionsSchema = exports.googleCloudStorageDestinationOptionsGoogleCloudStorageDestinationOptionsSchema = exports.cropSchema = exports.cropCropSchema = exports.generatedAssetSchema = exports.generatedAssetGeneratedAssetSchema = exports.stabilityAiGeneratedAssetSchema = exports.stabilityAiGeneratedAssetStabilityAiGeneratedAssetSchema = exports.stabilityAiGeneratedAssetOptionsSchema = exports.stabilityAiGeneratedAssetOptionsStabilityAiGeneratedAssetOptionsSchema = exports.stabilityAiTextToImageOptionsSchema = exports.stabilityAiTextToImageOptionsStabilityAiTextToImageOptionsSchema = exports.shotstackGeneratedAssetSchema = exports.shotstackGeneratedAssetShotstackGeneratedAssetSchema = exports.shotstackGeneratedAssetOptionsSchema = exports.shotstackGeneratedAssetOptionsShotstackGeneratedAssetOptionsSchema = exports.shotstackTextToSpeechOptionsSchema = exports.shotstackTextToSpeechOptionsShotstackTextToSpeechOptionsSchema = exports.shotstackTextToImageOptionsSchema = exports.shotstackTextToImageOptionsShotstackTextToImageOptionsSchema = exports.shotstackTextGeneratorOptionsSchema = exports.shotstackTextGeneratorOptionsShotstackTextGeneratorOptionsSchema = exports.shotstackImageToVideoOptionsSchema = exports.shotstackImageToVideoOptionsShotstackImageToVideoOptionsSchema = exports.generatedAssetResponseSchema = exports.generatedAssetResponseGeneratedAssetResponseSchema = exports.generatedAssetResponseDataSchema = exports.generatedAssetResponseDataGeneratedAssetResponseDataSchema = exports.generatedAssetResponseAttributesSchema = exports.generatedAssetResponseAttributesGeneratedAssetResponseAttributesSchema = exports.generatedAssetErrorResponseSchema = exports.generatedAssetErrorResponseGeneratedAssetErrorResponseSchema = exports.generatedAssetErrorResponseDataSchema = exports.generatedAssetErrorResponseDataGeneratedAssetErrorResponseDataSchema = void 0;
|
|
6
|
-
exports.
|
|
7
|
-
exports.
|
|
8
|
-
exports.
|
|
9
|
-
exports.
|
|
10
|
-
exports.getGeneratedAssetResponse = exports.getGeneratedAssetRequest = exports.postGenerateAssetResponse = exports.postGenerateAssetRequest = exports.getUploadSignedUrlResponse = exports.getUploadSignedUrlRequest = exports.getSourceResponse = exports.getSourceRequest = exports.deleteSourceResponse = exports.deleteSourceRequest = exports.postSourceResponse = exports.postSourceRequest = exports.getSourcesResponse = exports.getSourcesRequest = exports.postServeAssetResponse = exports.postServeAssetRequest = exports.getAssetByRenderIdResponse = exports.getAssetByRenderIdRequest = exports.getAssetResponse = exports.getAssetRequest = void 0;
|
|
6
|
+
exports.mergeFieldSchema = exports.mergefieldMergeFieldSchema = exports.lumaAssetSchema = exports.lumaassetLumaAssetSchema = exports.transcriptionSchema = exports.transcriptionTranscriptionSchema = exports.speedSchema = exports.speedSpeedSchema = exports.uploadResponseSchema = exports.uploadresponseUploadResponseSchema = exports.uploadResponseDataSchema = exports.uploadresponsedataUploadResponseDataSchema = exports.uploadResponseAttributesSchema = exports.uploadresponseattributesUploadResponseAttributesSchema = exports.queuedSourceResponseSchema = exports.queuedsourceresponseQueuedSourceResponseSchema = exports.queuedSourceResponseDataSchema = exports.queuedsourceresponsedataQueuedSourceResponseDataSchema = exports.ingestErrorResponseSchema = exports.ingesterrorresponseIngestErrorResponseSchema = exports.ingestErrorResponseDataSchema = exports.ingesterrorresponsedataIngestErrorResponseDataSchema = exports.enhancementsSchema = exports.enhancementsEnhancementsSchema = exports.audioEnhancementSchema = exports.audioEnhancementAudioEnhancementSchema = exports.dolbyEnhancementSchema = exports.dolbyEnhancementDolbyEnhancementSchema = exports.dolbyEnhancementOptionsSchema = exports.dolbyEnhancementOptionsDolbyEnhancementOptionsSchema = exports.imageToVideoAssetSchema = exports.imagetovideoassetImageToVideoAssetSchema = exports.imageAssetSchema = exports.imageassetImageAssetSchema = exports.htmlAssetSchema = exports.htmlassetHtmlAssetSchema = exports.fontSchema = exports.fontFontSchema = exports.flipTransformationSchema = exports.fliptransformationFlipTransformationSchema = exports.destinationsSchema = exports.destinationsDestinationsSchema = exports.vimeoDestinationSchema = exports.vimeoDestinationVimeoDestinationSchema = exports.vimeoDestinationOptionsSchema = exports.vimeoDestinationOptionsVimeoDestinationOptionsSchema = exports.vimeoDestinationPrivacyOptionsSchema = exports.vimeoDestinationPrivacyOptionsVimeoDestinationPrivacyOptionsSchema = exports.tiktokDestinationTiktokDestinationSchema = exports.tiktokDestinationOptionsTiktokDestinationOptionsSchema = void 0;
|
|
7
|
+
exports.transferResponseAttributesSchema = exports.transferresponseattributesTransferResponseAttributesSchema = exports.richTextAssetSchema = exports.richtextassetRichTextAssetSchema = exports.richTextStyleSchema = exports.richtextpropertiesRichTextStyleSchema = exports.richTextStrokeSchema = exports.richtextpropertiesRichTextStrokeSchema = exports.richTextShadowSchema = exports.richtextpropertiesRichTextShadowSchema = exports.richtextpropertiesRichTextPaddingSchema = exports.richTextGradientSchema = exports.richtextpropertiesRichTextGradientSchema = exports.richTextFontSchema = exports.richtextpropertiesRichTextFontSchema = exports.richtextpropertiesRichTextBorderSchema = exports.richTextBackgroundSchema = exports.richtextpropertiesRichTextBackgroundSchema = exports.richTextAnimationSchema = exports.richtextpropertiesRichTextAnimationSchema = exports.richTextAlignmentSchema = exports.richtextpropertiesRichTextAlignmentSchema = exports.templateResponseSchema = exports.templateresponseTemplateResponseSchema = exports.templateResponseDataSchema = exports.templateresponsedataTemplateResponseDataSchema = exports.templateListResponseSchema = exports.templatelistresponseTemplateListResponseSchema = exports.templateListResponseDataSchema = exports.templatelistresponsedataTemplateListResponseDataSchema = exports.templateListResponseItemSchema = exports.templatelistresponseitemTemplateListResponseItemSchema = exports.queuedResponseSchema = exports.queuedresponseQueuedResponseSchema = exports.queuedResponseDataSchema = exports.queuedresponsedataQueuedResponseDataSchema = exports.probeResponseSchema = exports.proberesponseProbeResponseSchema = exports.assetResponseSchema = exports.assetresponseAssetResponseSchema = exports.assetRenderResponseSchema = exports.assetrenderresponseAssetRenderResponseSchema = exports.assetResponseDataSchema = exports.assetresponsedataAssetResponseDataSchema = exports.assetResponseAttributesSchema = exports.assetresponseattributesAssetResponseAttributesSchema = exports.rangeSchema = exports.rangeRangeSchema = exports.posterSchema = exports.posterPosterSchema = void 0;
|
|
8
|
+
exports.transitionSchema = exports.transitionTransitionSchema = exports.outputSchema = exports.outputOutputSchema = exports.thumbnailSchema = exports.thumbnailThumbnailSchema = exports.textToImageAssetSchema = exports.texttoimageassetTextToImageAssetSchema = exports.textAssetSchema = exports.textassetTextAssetSchema = exports.textpropertiesTextStrokeSchema = exports.textFontSchema = exports.textpropertiesTextFontSchema = exports.textBackgroundSchema = exports.textpropertiesTextBackgroundSchema = exports.textpropertiesTextAnimationSchema = exports.textAlignmentSchema = exports.textpropertiesTextAlignmentSchema = exports.templateRenderSchema = exports.templaterenderTemplateRenderSchema = exports.soundtrackSchema = exports.soundtrackSoundtrackSchema = exports.sourceSchema = exports.sourceSourceSchema = exports.sourceResponseSchema = exports.sourceresponseSourceResponseSchema = exports.sourceListResponseSchema = exports.sourcelistresponseSourceListResponseSchema = exports.sourceResponseDataSchema = exports.sourceresponsedataSourceResponseDataSchema = exports.sourceResponseAttributesSchema = exports.sourceresponseattributesSourceResponseAttributesSchema = exports.outputsResponseSchema = exports.outputsresponseOutputsResponseSchema = exports.renditionResponseAttributesSchema = exports.renditionresponseattributesRenditionResponseAttributesSchema = exports.outputsSchema = exports.outputsOutputsSchema = exports.renditionSchema = exports.renditionRenditionSchema = exports.sizeSchema = exports.sizeSizeSchema = exports.shapeAssetSchema = exports.shapeassetShapeAssetSchema = exports.transferSchema = exports.transferTransferSchema = exports.transferResponseSchema = exports.transferresponseTransferResponseSchema = exports.transferResponseDataSchema = exports.transferresponsedataTransferResponseDataSchema = void 0;
|
|
9
|
+
exports.putTemplateResponse = exports.putTemplateRequest = exports.getTemplateResponse = exports.getTemplateRequest = exports.deleteTemplateResponse = exports.deleteTemplateRequest = exports.postTemplateResponse = exports.postTemplateRequest = exports.getTemplatesResponse = exports.getTemplatesRequest = exports.getRenderResponse = exports.getRenderRequest = exports.postRenderResponse = exports.postRenderRequest = exports.templateSchema = exports.templateTemplateSchema = exports.templateDataResponseSchema = exports.templatedataresponseTemplateDataResponseSchema = exports.templateDataResponseDataSchema = exports.templatedataresponsedataTemplateDataResponseDataSchema = exports.renderResponseSchema = exports.renderresponseRenderResponseSchema = exports.renderResponseDataSchema = exports.renderresponsedataRenderResponseDataSchema = exports.editSchema = exports.editEditSchema = exports.timelineSchema = exports.timelineTimelineSchema = exports.trackSchema = exports.trackTrackSchema = exports.clipSchema = exports.clipClipSchema = exports.assetSchema = exports.assetAssetSchema = exports.videoAssetSchema = exports.videoassetVideoAssetSchema = exports.transformationSchema = exports.transformationTransformationSchema = exports.titleAssetSchema = exports.titleassetTitleAssetSchema = exports.skewTransformationSchema = exports.skewtransformationSkewTransformationSchema = exports.rotateTransformationSchema = exports.rotatetransformationRotateTransformationSchema = exports.offsetSchema = exports.offsetOffsetSchema = exports.audioAssetSchema = exports.audioassetAudioAssetSchema = exports.tweenSchema = exports.tweenTweenSchema = void 0;
|
|
10
|
+
exports.getGeneratedAssetResponse = exports.getGeneratedAssetRequest = exports.postGenerateAssetResponse = exports.postGenerateAssetRequest = exports.getUploadSignedUrlResponse = exports.getUploadSignedUrlRequest = exports.getSourceResponse = exports.getSourceRequest = exports.deleteSourceResponse = exports.deleteSourceRequest = exports.postSourceResponse = exports.postSourceRequest = exports.getSourcesResponse = exports.getSourcesRequest = exports.postServeAssetResponse = exports.postServeAssetRequest = exports.getAssetByRenderIdResponse = exports.getAssetByRenderIdRequest = exports.getAssetResponse = exports.getAssetRequest = exports.deleteAssetResponse = exports.deleteAssetRequest = exports.probeResponse = exports.probeRequest = exports.postTemplateRenderResponse = exports.postTemplateRenderRequest = void 0;
|
|
11
11
|
const zod_1 = require("zod");
|
|
12
12
|
exports.editRootSchema = zod_1.z.unknown();
|
|
13
13
|
exports.sourceRootSchema = zod_1.z.unknown();
|
|
@@ -724,6 +724,23 @@ exports.shotstackDestinationShotstackDestinationSchema = zod_1.z.object({
|
|
|
724
724
|
exclude: zod_1.z.optional(zod_1.z.boolean()),
|
|
725
725
|
});
|
|
726
726
|
exports.shotstackDestinationSchema = exports.shotstackDestinationShotstackDestinationSchema;
|
|
727
|
+
/**
|
|
728
|
+
* Pass additional options to control how TikTok publishes video.
|
|
729
|
+
*/
|
|
730
|
+
exports.tiktokDestinationOptionsTiktokDestinationOptionsSchema = zod_1.z.object({
|
|
731
|
+
title: zod_1.z.optional(zod_1.z.string().max(150)),
|
|
732
|
+
privacyLevel: zod_1.z.optional(zod_1.z.enum(["public", "friends", "private"])),
|
|
733
|
+
disableDuet: zod_1.z.optional(zod_1.z.boolean()).default(false),
|
|
734
|
+
disableStitch: zod_1.z.optional(zod_1.z.boolean()).default(false),
|
|
735
|
+
disableComment: zod_1.z.optional(zod_1.z.boolean()).default(false),
|
|
736
|
+
});
|
|
737
|
+
/**
|
|
738
|
+
* Send videos to TikTok. TikTok credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/tiktok), not in the request.
|
|
739
|
+
*/
|
|
740
|
+
exports.tiktokDestinationTiktokDestinationSchema = zod_1.z.object({
|
|
741
|
+
provider: zod_1.z.string().default("tiktok"),
|
|
742
|
+
options: zod_1.z.optional(exports.tiktokDestinationOptionsTiktokDestinationOptionsSchema),
|
|
743
|
+
});
|
|
727
744
|
/**
|
|
728
745
|
* Options to control the visibility of videos and privacy features.
|
|
729
746
|
*/
|
|
@@ -740,6 +757,7 @@ exports.vimeoDestinationOptionsVimeoDestinationOptionsSchema = zod_1.z.object({
|
|
|
740
757
|
name: zod_1.z.optional(zod_1.z.string()),
|
|
741
758
|
description: zod_1.z.optional(zod_1.z.string()),
|
|
742
759
|
privacy: zod_1.z.optional(exports.vimeoDestinationPrivacyOptionsVimeoDestinationPrivacyOptionsSchema),
|
|
760
|
+
folderUri: zod_1.z.optional(zod_1.z.string()),
|
|
743
761
|
});
|
|
744
762
|
exports.vimeoDestinationOptionsSchema = exports.vimeoDestinationOptionsVimeoDestinationOptionsSchema;
|
|
745
763
|
/**
|
|
@@ -786,6 +804,11 @@ exports.destinationsDestinationsSchema = zod_1.z.union([
|
|
|
786
804
|
destinations: zod_1.z.optional(zod_1.z.literal("vimeoDestination_VimeoDestination")),
|
|
787
805
|
})
|
|
788
806
|
.and(exports.vimeoDestinationVimeoDestinationSchema),
|
|
807
|
+
zod_1.z
|
|
808
|
+
.object({
|
|
809
|
+
destinations: zod_1.z.optional(zod_1.z.literal("tiktokDestination_TiktokDestination")),
|
|
810
|
+
})
|
|
811
|
+
.and(exports.tiktokDestinationTiktokDestinationSchema),
|
|
789
812
|
]);
|
|
790
813
|
exports.destinationsSchema = exports.destinationsDestinationsSchema;
|
|
791
814
|
/**
|
|
@@ -1144,6 +1167,15 @@ exports.richtextpropertiesRichTextBackgroundSchema = zod_1.z.object({
|
|
|
1144
1167
|
borderRadius: zod_1.z.optional(zod_1.z.number().gte(0)).default(0),
|
|
1145
1168
|
});
|
|
1146
1169
|
exports.richTextBackgroundSchema = exports.richtextpropertiesRichTextBackgroundSchema;
|
|
1170
|
+
/**
|
|
1171
|
+
* Border styling properties for the text bounding box.
|
|
1172
|
+
*/
|
|
1173
|
+
exports.richtextpropertiesRichTextBorderSchema = zod_1.z.object({
|
|
1174
|
+
width: zod_1.z.optional(zod_1.z.number().gte(0)).default(0),
|
|
1175
|
+
color: zod_1.z.optional(zod_1.z.string().regex(/^#[A-Fa-f0-9]{6}$/)).default("#000000"),
|
|
1176
|
+
opacity: zod_1.z.optional(zod_1.z.number().gte(0).lte(1)).default(1),
|
|
1177
|
+
radius: zod_1.z.optional(zod_1.z.number().gte(0)).default(0),
|
|
1178
|
+
});
|
|
1147
1179
|
/**
|
|
1148
1180
|
* Font properties for rich text.
|
|
1149
1181
|
*/
|
|
@@ -1170,6 +1202,15 @@ exports.richtextpropertiesRichTextGradientSchema = zod_1.z.object({
|
|
|
1170
1202
|
.min(2),
|
|
1171
1203
|
});
|
|
1172
1204
|
exports.richTextGradientSchema = exports.richtextpropertiesRichTextGradientSchema;
|
|
1205
|
+
/**
|
|
1206
|
+
* Padding properties for individual sides of the text bounding box.
|
|
1207
|
+
*/
|
|
1208
|
+
exports.richtextpropertiesRichTextPaddingSchema = zod_1.z.object({
|
|
1209
|
+
top: zod_1.z.optional(zod_1.z.number().gte(0)).default(0),
|
|
1210
|
+
right: zod_1.z.optional(zod_1.z.number().gte(0)).default(0),
|
|
1211
|
+
bottom: zod_1.z.optional(zod_1.z.number().gte(0)).default(0),
|
|
1212
|
+
left: zod_1.z.optional(zod_1.z.number().gte(0)).default(0),
|
|
1213
|
+
});
|
|
1173
1214
|
/**
|
|
1174
1215
|
* Text shadow properties.
|
|
1175
1216
|
*/
|
|
@@ -1209,13 +1250,13 @@ exports.richTextStyleSchema = exports.richtextpropertiesRichTextStyleSchema;
|
|
|
1209
1250
|
exports.richtextassetRichTextAssetSchema = zod_1.z.object({
|
|
1210
1251
|
type: zod_1.z.string().default("rich-text"),
|
|
1211
1252
|
text: zod_1.z.string().max(5000),
|
|
1212
|
-
width: zod_1.z.optional(zod_1.z.int().gte(1).lte(4096)),
|
|
1213
|
-
height: zod_1.z.optional(zod_1.z.int().gte(1).lte(4096)),
|
|
1214
1253
|
font: zod_1.z.optional(exports.richtextpropertiesRichTextFontSchema),
|
|
1215
1254
|
style: zod_1.z.optional(exports.richtextpropertiesRichTextStyleSchema),
|
|
1216
1255
|
stroke: zod_1.z.optional(exports.richtextpropertiesRichTextStrokeSchema),
|
|
1217
1256
|
shadow: zod_1.z.optional(exports.richtextpropertiesRichTextShadowSchema),
|
|
1218
1257
|
background: zod_1.z.optional(exports.richtextpropertiesRichTextBackgroundSchema),
|
|
1258
|
+
border: zod_1.z.optional(exports.richtextpropertiesRichTextBorderSchema),
|
|
1259
|
+
padding: zod_1.z.optional(zod_1.z.union([zod_1.z.number().gte(0), exports.richtextpropertiesRichTextPaddingSchema])),
|
|
1219
1260
|
align: zod_1.z.optional(exports.richtextpropertiesRichTextAlignmentSchema),
|
|
1220
1261
|
animation: zod_1.z.optional(exports.richtextpropertiesRichTextAnimationSchema),
|
|
1221
1262
|
});
|
|
@@ -1454,11 +1495,21 @@ exports.textpropertiesTextAlignmentSchema = zod_1.z.object({
|
|
|
1454
1495
|
vertical: zod_1.z.optional(zod_1.z.enum(["top", "center", "bottom"])),
|
|
1455
1496
|
});
|
|
1456
1497
|
exports.textAlignmentSchema = exports.textpropertiesTextAlignmentSchema;
|
|
1498
|
+
/**
|
|
1499
|
+
* Animation properties for text entrance effects.
|
|
1500
|
+
*/
|
|
1501
|
+
exports.textpropertiesTextAnimationSchema = zod_1.z.object({
|
|
1502
|
+
preset: zod_1.z.enum(["typewriter"]),
|
|
1503
|
+
duration: zod_1.z.optional(zod_1.z.number().gte(0.1).lte(30)),
|
|
1504
|
+
});
|
|
1457
1505
|
/**
|
|
1458
1506
|
* Displays a background box behind the text.
|
|
1459
1507
|
*/
|
|
1460
1508
|
exports.textpropertiesTextBackgroundSchema = zod_1.z.object({
|
|
1461
|
-
color: zod_1.z.optional(zod_1.z.string()),
|
|
1509
|
+
color: zod_1.z.optional(zod_1.z.string().regex(/^#[A-Fa-f0-9]{6}$/)),
|
|
1510
|
+
opacity: zod_1.z.optional(zod_1.z.number().gte(0).lte(1)),
|
|
1511
|
+
padding: zod_1.z.optional(zod_1.z.number().gte(0).lte(100)),
|
|
1512
|
+
borderRadius: zod_1.z.optional(zod_1.z.number().gte(0)),
|
|
1462
1513
|
});
|
|
1463
1514
|
exports.textBackgroundSchema = exports.textpropertiesTextBackgroundSchema;
|
|
1464
1515
|
/**
|
|
@@ -1473,6 +1524,13 @@ exports.textpropertiesTextFontSchema = zod_1.z.object({
|
|
|
1473
1524
|
lineHeight: zod_1.z.optional(zod_1.z.number()),
|
|
1474
1525
|
});
|
|
1475
1526
|
exports.textFontSchema = exports.textpropertiesTextFontSchema;
|
|
1527
|
+
/**
|
|
1528
|
+
* Text stroke (outline) properties.
|
|
1529
|
+
*/
|
|
1530
|
+
exports.textpropertiesTextStrokeSchema = zod_1.z.object({
|
|
1531
|
+
width: zod_1.z.optional(zod_1.z.number().gte(0).lte(10)),
|
|
1532
|
+
color: zod_1.z.optional(zod_1.z.string().regex(/^#[A-Fa-f0-9]{6}$/)),
|
|
1533
|
+
});
|
|
1476
1534
|
/**
|
|
1477
1535
|
* The TextAsset is used to add text and titles to a video. The text can be styled with built in and custom
|
|
1478
1536
|
* [Fonts](#tocs_font). You can also add a background bounding box used to control wrapping and overflow. Emoticons are also supported.
|
|
@@ -1486,6 +1544,9 @@ exports.textassetTextAssetSchema = zod_1.z.object({
|
|
|
1486
1544
|
font: zod_1.z.optional(exports.textpropertiesTextFontSchema),
|
|
1487
1545
|
background: zod_1.z.optional(exports.textpropertiesTextBackgroundSchema),
|
|
1488
1546
|
alignment: zod_1.z.optional(exports.textpropertiesTextAlignmentSchema),
|
|
1547
|
+
stroke: zod_1.z.optional(exports.textpropertiesTextStrokeSchema),
|
|
1548
|
+
animation: zod_1.z.optional(exports.textpropertiesTextAnimationSchema),
|
|
1549
|
+
ellipsis: zod_1.z.optional(zod_1.z.string()),
|
|
1489
1550
|
});
|
|
1490
1551
|
exports.textAssetSchema = exports.textassetTextAssetSchema;
|
|
1491
1552
|
/**
|
|
@@ -1528,7 +1589,7 @@ exports.outputOutputSchema = zod_1.z.object({
|
|
|
1528
1589
|
zod_1.z.literal(59.94),
|
|
1529
1590
|
zod_1.z.literal(60),
|
|
1530
1591
|
])),
|
|
1531
|
-
scaleTo: zod_1.z.optional(zod_1.z.enum(["preview", "mobile", "sd", "hd", "1080"])),
|
|
1592
|
+
scaleTo: zod_1.z.optional(zod_1.z.enum(["preview", "mobile", "sd", "hd", "1080", "4k"])),
|
|
1532
1593
|
quality: zod_1.z.optional(zod_1.z.enum(["verylow", "low", "medium", "high", "veryhigh"])),
|
|
1533
1594
|
repeat: zod_1.z.optional(zod_1.z.boolean()),
|
|
1534
1595
|
mute: zod_1.z.optional(zod_1.z.boolean()),
|
|
@@ -1543,6 +1604,7 @@ exports.outputSchema = exports.outputOutputSchema;
|
|
|
1543
1604
|
*/
|
|
1544
1605
|
exports.transitionTransitionSchema = zod_1.z.object({
|
|
1545
1606
|
in: zod_1.z.optional(zod_1.z.enum([
|
|
1607
|
+
"none",
|
|
1546
1608
|
"fade",
|
|
1547
1609
|
"fadeSlow",
|
|
1548
1610
|
"fadeFast",
|
|
@@ -1606,6 +1668,7 @@ exports.transitionTransitionSchema = zod_1.z.object({
|
|
|
1606
1668
|
"zoom",
|
|
1607
1669
|
])),
|
|
1608
1670
|
out: zod_1.z.optional(zod_1.z.enum([
|
|
1671
|
+
"none",
|
|
1609
1672
|
"fade",
|
|
1610
1673
|
"fadeSlow",
|
|
1611
1674
|
"fadeFast",
|
|
@@ -1727,7 +1790,7 @@ exports.audioassetAudioAssetSchema = zod_1.z.object({
|
|
|
1727
1790
|
trim: zod_1.z.optional(zod_1.z.number()),
|
|
1728
1791
|
volume: zod_1.z.optional(zod_1.z.union([zod_1.z.number().gte(0).lte(1), zod_1.z.array(exports.tweenTweenSchema)])),
|
|
1729
1792
|
speed: zod_1.z.optional(zod_1.z.number().gte(0).lte(10)),
|
|
1730
|
-
effect: zod_1.z.optional(zod_1.z.enum(["fadeIn", "fadeOut", "fadeInFadeOut"])),
|
|
1793
|
+
effect: zod_1.z.optional(zod_1.z.enum(["none", "fadeIn", "fadeOut", "fadeInFadeOut"])),
|
|
1731
1794
|
});
|
|
1732
1795
|
exports.audioAssetSchema = exports.audioassetAudioAssetSchema;
|
|
1733
1796
|
/**
|
|
@@ -1746,11 +1809,11 @@ exports.rotatetransformationRotateTransformationSchema = zod_1.z.object({
|
|
|
1746
1809
|
});
|
|
1747
1810
|
exports.rotateTransformationSchema = exports.rotatetransformationRotateTransformationSchema;
|
|
1748
1811
|
/**
|
|
1749
|
-
* Skew a clip so its edges are sheared at an angle. Use values between
|
|
1812
|
+
* Skew a clip so its edges are sheared at an angle. Use values between -100 and 100. Values over 3 or under -3 will skew the clip almost flat.
|
|
1750
1813
|
*/
|
|
1751
1814
|
exports.skewtransformationSkewTransformationSchema = zod_1.z.object({
|
|
1752
|
-
x: zod_1.z.optional(zod_1.z.union([zod_1.z.number(), zod_1.z.array(exports.tweenTweenSchema)])),
|
|
1753
|
-
y: zod_1.z.optional(zod_1.z.union([zod_1.z.number(), zod_1.z.array(exports.tweenTweenSchema)])),
|
|
1815
|
+
x: zod_1.z.optional(zod_1.z.union([zod_1.z.number().gte(-100).lte(100), zod_1.z.array(exports.tweenTweenSchema)])),
|
|
1816
|
+
y: zod_1.z.optional(zod_1.z.union([zod_1.z.number().gte(-100).lte(100), zod_1.z.array(exports.tweenTweenSchema)])),
|
|
1754
1817
|
});
|
|
1755
1818
|
exports.skewTransformationSchema = exports.skewtransformationSkewTransformationSchema;
|
|
1756
1819
|
/**
|
|
@@ -1819,7 +1882,7 @@ exports.videoassetVideoAssetSchema = zod_1.z.object({
|
|
|
1819
1882
|
transcode: zod_1.z.optional(zod_1.z.boolean()).default(false),
|
|
1820
1883
|
trim: zod_1.z.optional(zod_1.z.number()),
|
|
1821
1884
|
volume: zod_1.z.optional(zod_1.z.union([zod_1.z.number().gte(0).lte(1), zod_1.z.array(exports.tweenTweenSchema)])),
|
|
1822
|
-
volumeEffect: zod_1.z.optional(zod_1.z.enum(["fadeIn", "fadeOut", "fadeInFadeOut"])),
|
|
1885
|
+
volumeEffect: zod_1.z.optional(zod_1.z.enum(["none", "fadeIn", "fadeOut", "fadeInFadeOut"])),
|
|
1823
1886
|
speed: zod_1.z.optional(zod_1.z.number().gte(0).lte(10)),
|
|
1824
1887
|
crop: zod_1.z.optional(exports.cropCropSchema),
|
|
1825
1888
|
chromaKey: zod_1.z.optional(exports.chromakeyChromaKeySchema),
|
|
@@ -1900,6 +1963,8 @@ exports.clipClipSchema = zod_1.z.object({
|
|
|
1900
1963
|
length: zod_1.z.union([zod_1.z.number(), zod_1.z.literal("auto"), zod_1.z.literal("end")]),
|
|
1901
1964
|
fit: zod_1.z.optional(zod_1.z.enum(["cover", "contain", "crop", "none"])),
|
|
1902
1965
|
scale: zod_1.z.optional(zod_1.z.number()),
|
|
1966
|
+
width: zod_1.z.optional(zod_1.z.int().gte(1).lte(3840)),
|
|
1967
|
+
height: zod_1.z.optional(zod_1.z.int().gte(1).lte(2160)),
|
|
1903
1968
|
position: zod_1.z.optional(zod_1.z.enum([
|
|
1904
1969
|
"top",
|
|
1905
1970
|
"topRight",
|
|
@@ -1945,6 +2010,7 @@ exports.clipClipSchema = zod_1.z.object({
|
|
|
1945
2010
|
])),
|
|
1946
2011
|
opacity: zod_1.z.optional(zod_1.z.union([zod_1.z.number(), zod_1.z.array(exports.tweenTweenSchema)])),
|
|
1947
2012
|
transform: zod_1.z.optional(exports.transformationTransformationSchema),
|
|
2013
|
+
alias: zod_1.z.optional(zod_1.z.string().regex(/^[A-Za-z0-9_-]+$/)),
|
|
1948
2014
|
});
|
|
1949
2015
|
exports.clipSchema = exports.clipClipSchema;
|
|
1950
2016
|
/**
|