@shotstack/schemas 1.5.7 → 1.5.8
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 +90 -5
- package/dist/schema.d.ts +1 -2
- package/dist/zod/zod.gen.cjs +173 -173
- package/dist/zod/zod.gen.d.ts +3727 -3727
- package/dist/zod/zod.gen.js +173 -173
- package/dist/zod/zod.gen.ts +173 -173
- package/package.json +1 -1
package/dist/zod/zod.gen.js
CHANGED
|
@@ -42,7 +42,7 @@ export const captionpropertiesCaptionBackgroundSchema = z.object({
|
|
|
42
42
|
return v;
|
|
43
43
|
return Number(v);
|
|
44
44
|
} return v; }), z.number().int()), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
|
|
45
|
-
});
|
|
45
|
+
}).strict();
|
|
46
46
|
export const captionBackgroundSchema = captionpropertiesCaptionBackgroundSchema;
|
|
47
47
|
/**
|
|
48
48
|
* Font properties for captions text.
|
|
@@ -79,7 +79,7 @@ export const captionpropertiesCaptionFontSchema = z.object({
|
|
|
79
79
|
return v;
|
|
80
80
|
return Number(v);
|
|
81
81
|
} return v; }), z.number()), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
|
|
82
|
-
});
|
|
82
|
+
}).strict();
|
|
83
83
|
export const captionFontSchema = captionpropertiesCaptionFontSchema;
|
|
84
84
|
/**
|
|
85
85
|
* The margin properties for captions. Margins are used to position the caption text and background on the screen.
|
|
@@ -106,7 +106,7 @@ export const captionpropertiesCaptionMarginSchema = z.object({
|
|
|
106
106
|
return v;
|
|
107
107
|
return Number(v);
|
|
108
108
|
} return v; }), z.number()), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
|
|
109
|
-
});
|
|
109
|
+
}).strict();
|
|
110
110
|
export const captionMarginSchema = captionpropertiesCaptionMarginSchema;
|
|
111
111
|
/**
|
|
112
112
|
* The CaptionAsset is used to add captions (subtitles) to a video. It uses a supplied SRT or VTT file which will
|
|
@@ -140,7 +140,7 @@ export const captionassetCaptionAssetSchema = z.object({
|
|
|
140
140
|
return v;
|
|
141
141
|
return Number(v);
|
|
142
142
|
} return v; }), z.number().gte(0).lte(10)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
|
|
143
|
-
});
|
|
143
|
+
}).strict();
|
|
144
144
|
export const captionAssetSchema = captionassetCaptionAssetSchema;
|
|
145
145
|
/**
|
|
146
146
|
* Chroma key is a technique that replaces a specific color in a video with a different background image or video, enabling seamless integration of diverse environments. Commonly used for green screen and blue screen effects.
|
|
@@ -161,7 +161,7 @@ export const chromakeyChromaKeySchema = z.object({
|
|
|
161
161
|
return v;
|
|
162
162
|
return Number(v);
|
|
163
163
|
} return v; }), z.number().int().gte(0).lte(250)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
|
|
164
|
-
});
|
|
164
|
+
}).strict();
|
|
165
165
|
export const chromaKeySchema = chromakeyChromaKeySchema;
|
|
166
166
|
/**
|
|
167
167
|
* Options for the D-ID text-to-avatar service. Set the text to be converted to an avatar and configure the avatar and background. The output will be generated as an MP4 video file.
|
|
@@ -171,7 +171,7 @@ export const didTextToAvatarOptionsDidTextToAvatarOptionsSchema = z.object({
|
|
|
171
171
|
text: z.string(),
|
|
172
172
|
avatar: z.enum(["jack", "lana", "lily", "matt", "rian"]),
|
|
173
173
|
background: z.optional(z.string()),
|
|
174
|
-
});
|
|
174
|
+
}).strict();
|
|
175
175
|
export const didTextToAvatarOptionsSchema = didTextToAvatarOptionsDidTextToAvatarOptionsSchema;
|
|
176
176
|
/**
|
|
177
177
|
* Generate assets using the third party D-ID provider AI services.
|
|
@@ -192,7 +192,7 @@ export const didGeneratedAssetOptionsSchema = didGeneratedAssetOptionsDidGenerat
|
|
|
192
192
|
export const didGeneratedAssetDidGeneratedAssetSchema = z.object({
|
|
193
193
|
provider: z.enum(["d-id"]),
|
|
194
194
|
options: didGeneratedAssetOptionsDidGeneratedAssetOptionsSchema,
|
|
195
|
-
});
|
|
195
|
+
}).strict();
|
|
196
196
|
export const didGeneratedAssetSchema = didGeneratedAssetDidGeneratedAssetSchema;
|
|
197
197
|
/**
|
|
198
198
|
* Options for the ElevenLabs text-to-speech service. Set the text to be converted to speech and choose a voice to set the speaking style. The output will be generated as an MP3 audio file available at the URL returned in the response.
|
|
@@ -211,7 +211,7 @@ export const elevenlabsTextToSpeechOptionsElevenLabsTextToSpeechOptionsSchema =
|
|
|
211
211
|
"Rachel",
|
|
212
212
|
"Sam",
|
|
213
213
|
]),
|
|
214
|
-
});
|
|
214
|
+
}).strict();
|
|
215
215
|
export const elevenLabsTextToSpeechOptionsSchema = elevenlabsTextToSpeechOptionsElevenLabsTextToSpeechOptionsSchema;
|
|
216
216
|
/**
|
|
217
217
|
* Generate assets using the third party ElevenLabs provider AI services.
|
|
@@ -232,7 +232,7 @@ export const elevenLabsGeneratedAssetOptionsSchema = elevenlabsGeneratedAssetOpt
|
|
|
232
232
|
export const elevenlabsGeneratedAssetElevenLabsGeneratedAssetSchema = z.object({
|
|
233
233
|
provider: z.enum(["elevenlabs"]),
|
|
234
234
|
options: elevenlabsGeneratedAssetOptionsElevenLabsGeneratedAssetOptionsSchema,
|
|
235
|
-
});
|
|
235
|
+
}).strict();
|
|
236
236
|
export const elevenLabsGeneratedAssetSchema = elevenlabsGeneratedAssetElevenLabsGeneratedAssetSchema;
|
|
237
237
|
/**
|
|
238
238
|
* Options for the HeyGen text-to-avatar service. Set the text to be converted to an avatar and configure the avatars voice, speaking style, appearance and background. The output will be generated as an MP4 video file available at the URL returned in the response.
|
|
@@ -357,7 +357,7 @@ export const heygenTextToAvatarOptionsHeyGenTextToAvatarOptionsSchema = z.object
|
|
|
357
357
|
background: z.optional(z.string()),
|
|
358
358
|
ratio: z.optional(z.enum(["16:9", "9:16"])),
|
|
359
359
|
test: z.optional(z.boolean()),
|
|
360
|
-
});
|
|
360
|
+
}).strict();
|
|
361
361
|
export const heyGenTextToAvatarOptionsSchema = heygenTextToAvatarOptionsHeyGenTextToAvatarOptionsSchema;
|
|
362
362
|
/**
|
|
363
363
|
* Generate assets using the third party HeyGen provider AI services.
|
|
@@ -378,7 +378,7 @@ export const heyGenGeneratedAssetOptionsSchema = heygenGeneratedAssetOptionsHeyG
|
|
|
378
378
|
export const heygenGeneratedAssetHeyGenGeneratedAssetSchema = z.object({
|
|
379
379
|
provider: z.enum(["heygen"]),
|
|
380
380
|
options: heygenGeneratedAssetOptionsHeyGenGeneratedAssetOptionsSchema,
|
|
381
|
-
});
|
|
381
|
+
}).strict();
|
|
382
382
|
export const heyGenGeneratedAssetSchema = heygenGeneratedAssetHeyGenGeneratedAssetSchema;
|
|
383
383
|
/**
|
|
384
384
|
* Options for the OpenAI text-generator service. Set a text prompt that will be used to generate a new body of text. The output will be generated as a text (txt) file available at the URL returned in the response.
|
|
@@ -388,7 +388,7 @@ export const openaiTextGeneratorOptionsOpenAiTextGeneratorOptionsSchema = z.obje
|
|
|
388
388
|
prompt: z.string(),
|
|
389
389
|
model: z.enum(["gpt-3.5-turbo", "gpt-4"]),
|
|
390
390
|
systemPrompt: z.optional(z.string()),
|
|
391
|
-
});
|
|
391
|
+
}).strict();
|
|
392
392
|
export const openAiTextGeneratorOptionsSchema = openaiTextGeneratorOptionsOpenAiTextGeneratorOptionsSchema;
|
|
393
393
|
/**
|
|
394
394
|
* Generate assets using OpenAI provider AI services.
|
|
@@ -409,7 +409,7 @@ export const openAiGeneratedAssetOptionsSchema = openaiGeneratedAssetOptionsOpen
|
|
|
409
409
|
export const openaiGeneratedAssetOpenAiGeneratedAssetSchema = z.object({
|
|
410
410
|
provider: z.enum(["openai"]),
|
|
411
411
|
options: openaiGeneratedAssetOptionsOpenAiGeneratedAssetOptionsSchema,
|
|
412
|
-
});
|
|
412
|
+
}).strict();
|
|
413
413
|
export const openAiGeneratedAssetSchema = openaiGeneratedAssetOpenAiGeneratedAssetSchema;
|
|
414
414
|
/**
|
|
415
415
|
* Individual errors returned by the Create API.
|
|
@@ -418,14 +418,14 @@ export const generatedAssetErrorResponseDataGeneratedAssetErrorResponseDataSchem
|
|
|
418
418
|
status: z.string(),
|
|
419
419
|
title: z.string(),
|
|
420
420
|
detail: z.string(),
|
|
421
|
-
});
|
|
421
|
+
}).strict();
|
|
422
422
|
export const generatedAssetErrorResponseDataSchema = generatedAssetErrorResponseDataGeneratedAssetErrorResponseDataSchema;
|
|
423
423
|
/**
|
|
424
424
|
* Error response data for validation and other errors returned by the Create API.
|
|
425
425
|
*/
|
|
426
426
|
export const generatedAssetErrorResponseGeneratedAssetErrorResponseSchema = z.object({
|
|
427
427
|
errors: z.array(generatedAssetErrorResponseDataGeneratedAssetErrorResponseDataSchema),
|
|
428
|
-
});
|
|
428
|
+
}).strict();
|
|
429
429
|
export const generatedAssetErrorResponseSchema = generatedAssetErrorResponseGeneratedAssetErrorResponseSchema;
|
|
430
430
|
/**
|
|
431
431
|
* The id and attributes of the generated asset.
|
|
@@ -438,7 +438,7 @@ export const generatedAssetResponseAttributesGeneratedAssetResponseAttributesSch
|
|
|
438
438
|
status: z.enum(["queued", "processing", "saving", "done", "failed"]),
|
|
439
439
|
created: z.string(),
|
|
440
440
|
updated: z.string(),
|
|
441
|
-
});
|
|
441
|
+
}).strict();
|
|
442
442
|
export const generatedAssetResponseAttributesSchema = generatedAssetResponseAttributesGeneratedAssetResponseAttributesSchema;
|
|
443
443
|
/**
|
|
444
444
|
* The type of resource (an asset), it's id and attributes of the generated file.
|
|
@@ -447,14 +447,14 @@ export const generatedAssetResponseDataGeneratedAssetResponseDataSchema = z.obje
|
|
|
447
447
|
type: z.string(),
|
|
448
448
|
id: z.string(),
|
|
449
449
|
attributes: generatedAssetResponseAttributesGeneratedAssetResponseAttributesSchema,
|
|
450
|
-
});
|
|
450
|
+
}).strict();
|
|
451
451
|
export const generatedAssetResponseDataSchema = generatedAssetResponseDataGeneratedAssetResponseDataSchema;
|
|
452
452
|
/**
|
|
453
453
|
* The response returned by the Create API [generate asset](#generate-asset) and [get generated asset](#get-generated-asset) requests. Includes status and details of the generated asset. The response follows the [json:api](https://jsonapi.org/) specification.
|
|
454
454
|
*/
|
|
455
455
|
export const generatedAssetResponseGeneratedAssetResponseSchema = z.object({
|
|
456
456
|
data: generatedAssetResponseDataGeneratedAssetResponseDataSchema,
|
|
457
|
-
});
|
|
457
|
+
}).strict();
|
|
458
458
|
export const generatedAssetResponseSchema = generatedAssetResponseGeneratedAssetResponseSchema;
|
|
459
459
|
/**
|
|
460
460
|
* Options for the Shotstack image-to-video service. Set the URL of an image to convert in to a video. The output will be generated as an MP4 file available at the URL returned in the response.
|
|
@@ -476,7 +476,7 @@ export const shotstackImageToVideoOptionsShotstackImageToVideoOptionsSchema = z.
|
|
|
476
476
|
return v;
|
|
477
477
|
return Number(v);
|
|
478
478
|
} return v; }), z.number().int()), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(127),
|
|
479
|
-
});
|
|
479
|
+
}).strict();
|
|
480
480
|
export const shotstackImageToVideoOptionsSchema = shotstackImageToVideoOptionsShotstackImageToVideoOptionsSchema;
|
|
481
481
|
/**
|
|
482
482
|
* Options for the Shotstack text-generator service. Set a text prompt that will be used to generate a new body of text. The output will be generated as a text (txt) file available at the URL returned in the response.
|
|
@@ -484,7 +484,7 @@ export const shotstackImageToVideoOptionsSchema = shotstackImageToVideoOptionsSh
|
|
|
484
484
|
export const shotstackTextGeneratorOptionsShotstackTextGeneratorOptionsSchema = z.object({
|
|
485
485
|
type: z.enum(["text-generator"]),
|
|
486
486
|
prompt: z.string(),
|
|
487
|
-
});
|
|
487
|
+
}).strict();
|
|
488
488
|
export const shotstackTextGeneratorOptionsSchema = shotstackTextGeneratorOptionsShotstackTextGeneratorOptionsSchema;
|
|
489
489
|
/**
|
|
490
490
|
* Options for the Shotstack text-to-image service. Set a text prompt to generate an image from. The output will be generated as a PNG file available at the URL returned in the response.
|
|
@@ -506,7 +506,7 @@ export const shotstackTextToImageOptionsShotstackTextToImageOptionsSchema = z.ob
|
|
|
506
506
|
return v;
|
|
507
507
|
return Number(v);
|
|
508
508
|
} return v; }), z.number().int()), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]),
|
|
509
|
-
});
|
|
509
|
+
}).strict();
|
|
510
510
|
export const shotstackTextToImageOptionsSchema = shotstackTextToImageOptionsShotstackTextToImageOptionsSchema;
|
|
511
511
|
/**
|
|
512
512
|
* Options for the Shotstack text-to-speech service. Set the text to be converted to speech and choose a voice to set the speaking style. The output will be generated as an MP3 audio file available at the URL returned in the response.
|
|
@@ -605,7 +605,7 @@ export const shotstackTextToSpeechOptionsShotstackTextToSpeechOptionsSchema = z.
|
|
|
605
605
|
"fi-FI",
|
|
606
606
|
])),
|
|
607
607
|
newscaster: z.optional(z.boolean()).default(false),
|
|
608
|
-
});
|
|
608
|
+
}).strict();
|
|
609
609
|
export const shotstackTextToSpeechOptionsSchema = shotstackTextToSpeechOptionsShotstackTextToSpeechOptionsSchema;
|
|
610
610
|
/**
|
|
611
611
|
* Generate assets using the native Shotstack provider AI services.
|
|
@@ -639,7 +639,7 @@ export const shotstackGeneratedAssetOptionsSchema = shotstackGeneratedAssetOptio
|
|
|
639
639
|
export const shotstackGeneratedAssetShotstackGeneratedAssetSchema = z.object({
|
|
640
640
|
provider: z.enum(["shotstack"]),
|
|
641
641
|
options: shotstackGeneratedAssetOptionsShotstackGeneratedAssetOptionsSchema,
|
|
642
|
-
});
|
|
642
|
+
}).strict();
|
|
643
643
|
export const shotstackGeneratedAssetSchema = shotstackGeneratedAssetShotstackGeneratedAssetSchema;
|
|
644
644
|
/**
|
|
645
645
|
* Options for the Stability AI text-to-image service. Set a text prompt to generate an image from plus other engine and configuration options. The output will be generated as a JPG file available at the URL returned in the response.
|
|
@@ -708,7 +708,7 @@ export const stabilityAiTextToImageOptionsStabilityAiTextToImageOptionsSchema =
|
|
|
708
708
|
"pixel-art",
|
|
709
709
|
"tile-texture",
|
|
710
710
|
])),
|
|
711
|
-
});
|
|
711
|
+
}).strict();
|
|
712
712
|
export const stabilityAiTextToImageOptionsSchema = stabilityAiTextToImageOptionsStabilityAiTextToImageOptionsSchema;
|
|
713
713
|
/**
|
|
714
714
|
* Generate assets using Stability AI provider AI services.
|
|
@@ -729,7 +729,7 @@ export const stabilityAiGeneratedAssetOptionsSchema = stabilityAiGeneratedAssetO
|
|
|
729
729
|
export const stabilityAiGeneratedAssetStabilityAiGeneratedAssetSchema = z.object({
|
|
730
730
|
provider: z.enum(["stability-ai"]),
|
|
731
731
|
options: stabilityAiGeneratedAssetOptionsStabilityAiGeneratedAssetOptionsSchema,
|
|
732
|
-
});
|
|
732
|
+
}).strict();
|
|
733
733
|
export const stabilityAiGeneratedAssetSchema = stabilityAiGeneratedAssetStabilityAiGeneratedAssetSchema;
|
|
734
734
|
/**
|
|
735
735
|
* A generated asset is a media asset created by the Create API. You can use native or third party providers to generate video, audio and image files using Generative AI services like text-to-speech and text-to-avatar.
|
|
@@ -799,7 +799,7 @@ export const cropCropSchema = z.object({
|
|
|
799
799
|
return v;
|
|
800
800
|
return Number(v);
|
|
801
801
|
} return v; }), z.number().gte(0).lte(1)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
|
|
802
|
-
});
|
|
802
|
+
}).strict();
|
|
803
803
|
export const cropSchema = cropCropSchema;
|
|
804
804
|
/**
|
|
805
805
|
* Pass additional options to control how files are stored in Google Cloud Storage.
|
|
@@ -808,7 +808,7 @@ export const googleCloudStorageDestinationOptionsGoogleCloudStorageDestinationOp
|
|
|
808
808
|
bucket: z.string(),
|
|
809
809
|
prefix: z.optional(z.string()),
|
|
810
810
|
filename: z.optional(z.string()),
|
|
811
|
-
});
|
|
811
|
+
}).strict();
|
|
812
812
|
export const googleCloudStorageDestinationOptionsSchema = googleCloudStorageDestinationOptionsGoogleCloudStorageDestinationOptionsSchema;
|
|
813
813
|
/**
|
|
814
814
|
* Send videos and assets to a [Google Cloud Storage](https://cloud.google.com/storage) bucket. Send files with your own prefix and filename. Google Cloud credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/google-cloud-storage), not in the request.
|
|
@@ -816,7 +816,7 @@ export const googleCloudStorageDestinationOptionsSchema = googleCloudStorageDest
|
|
|
816
816
|
export const googleCloudStorageDestinationGoogleCloudStorageDestinationSchema = z.object({
|
|
817
817
|
provider: z.literal("google-cloud-storage"),
|
|
818
818
|
options: z.optional(googleCloudStorageDestinationOptionsGoogleCloudStorageDestinationOptionsSchema),
|
|
819
|
-
});
|
|
819
|
+
}).strict();
|
|
820
820
|
export const googleCloudStorageDestinationSchema = googleCloudStorageDestinationGoogleCloudStorageDestinationSchema;
|
|
821
821
|
/**
|
|
822
822
|
* Pass the folder ID and options to configure how assets are stored in Google Drive.
|
|
@@ -824,7 +824,7 @@ export const googleCloudStorageDestinationSchema = googleCloudStorageDestination
|
|
|
824
824
|
export const googleDriveDestinationOptionsGoogleDriveDestinationOptionsSchema = z.object({
|
|
825
825
|
folderId: z.string(),
|
|
826
826
|
filename: z.optional(z.string()),
|
|
827
|
-
});
|
|
827
|
+
}).strict();
|
|
828
828
|
export const googleDriveDestinationOptionsSchema = googleDriveDestinationOptionsGoogleDriveDestinationOptionsSchema;
|
|
829
829
|
/**
|
|
830
830
|
* Send rendered videos and assets to the [Google Drive](https://shotstack.io/docs/guide/serving-assets/destinations/google-drive/) cloud storage service. Google Drive uses OAuth and you must authenticate and link your Google account via [dashboard](https://dashboard.shotstack.io/integrations/google-drive), not in the request.
|
|
@@ -832,7 +832,7 @@ export const googleDriveDestinationOptionsSchema = googleDriveDestinationOptions
|
|
|
832
832
|
export const googleDriveDestinationGoogleDriveDestinationSchema = z.object({
|
|
833
833
|
provider: z.literal("google-drive"),
|
|
834
834
|
options: googleDriveDestinationOptionsGoogleDriveDestinationOptionsSchema,
|
|
835
|
-
});
|
|
835
|
+
}).strict();
|
|
836
836
|
export const googleDriveDestinationSchema = googleDriveDestinationGoogleDriveDestinationSchema;
|
|
837
837
|
/**
|
|
838
838
|
* Pass additional options to control how Mux processes video. Currently supports playback_policy and passthrough options.
|
|
@@ -840,7 +840,7 @@ export const googleDriveDestinationSchema = googleDriveDestinationGoogleDriveDes
|
|
|
840
840
|
export const muxDestinationOptionsMuxDestinationOptionsSchema = z.object({
|
|
841
841
|
playbackPolicy: z.optional(z.array(z.enum(["public", "signed"]))),
|
|
842
842
|
passthrough: z.optional(z.string().max(255)),
|
|
843
|
-
});
|
|
843
|
+
}).strict();
|
|
844
844
|
export const muxDestinationOptionsSchema = muxDestinationOptionsMuxDestinationOptionsSchema;
|
|
845
845
|
/**
|
|
846
846
|
* Send videos to the [Mux](https://shotstack.io/docs/guide/serving-assets/destinations/mux/) video hosting and streaming service. Mux credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/mux), not in the request.
|
|
@@ -848,7 +848,7 @@ export const muxDestinationOptionsSchema = muxDestinationOptionsMuxDestinationOp
|
|
|
848
848
|
export const muxDestinationMuxDestinationSchema = z.object({
|
|
849
849
|
provider: z.literal("mux"),
|
|
850
850
|
options: z.optional(muxDestinationOptionsMuxDestinationOptionsSchema),
|
|
851
|
-
});
|
|
851
|
+
}).strict();
|
|
852
852
|
export const muxDestinationSchema = muxDestinationMuxDestinationSchema;
|
|
853
853
|
/**
|
|
854
854
|
* Pass additional options to control how files are stored in S3.
|
|
@@ -859,7 +859,7 @@ export const s3DestinationOptionsS3DestinationOptionsSchema = z.object({
|
|
|
859
859
|
prefix: z.optional(z.string()),
|
|
860
860
|
filename: z.optional(z.string()),
|
|
861
861
|
acl: z.optional(z.string()),
|
|
862
|
-
});
|
|
862
|
+
}).strict();
|
|
863
863
|
export const s3DestinationOptionsSchema = s3DestinationOptionsS3DestinationOptionsSchema;
|
|
864
864
|
/**
|
|
865
865
|
* Send videos and assets to an [Amazon S3](https://shotstack.io/docs/guide/serving-assets/destinations/s3/) bucket. Send files to any region with your own prefix and filename. AWS credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/s3), not in the request.
|
|
@@ -867,7 +867,7 @@ export const s3DestinationOptionsSchema = s3DestinationOptionsS3DestinationOptio
|
|
|
867
867
|
export const s3DestinationS3DestinationSchema = z.object({
|
|
868
868
|
provider: z.literal("s3"),
|
|
869
869
|
options: z.optional(s3DestinationOptionsS3DestinationOptionsSchema),
|
|
870
|
-
});
|
|
870
|
+
}).strict();
|
|
871
871
|
export const s3DestinationSchema = s3DestinationS3DestinationSchema;
|
|
872
872
|
/**
|
|
873
873
|
* 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.
|
|
@@ -875,7 +875,7 @@ export const s3DestinationSchema = s3DestinationS3DestinationSchema;
|
|
|
875
875
|
export const shotstackDestinationShotstackDestinationSchema = z.object({
|
|
876
876
|
provider: z.literal("shotstack"),
|
|
877
877
|
exclude: z.optional(z.boolean()),
|
|
878
|
-
});
|
|
878
|
+
}).strict();
|
|
879
879
|
export const shotstackDestinationSchema = shotstackDestinationShotstackDestinationSchema;
|
|
880
880
|
/**
|
|
881
881
|
* Pass additional options to control how TikTok publishes video.
|
|
@@ -886,14 +886,14 @@ export const tiktokDestinationOptionsTiktokDestinationOptionsSchema = z.object({
|
|
|
886
886
|
disableDuet: z.optional(z.boolean()).default(false),
|
|
887
887
|
disableStitch: z.optional(z.boolean()).default(false),
|
|
888
888
|
disableComment: z.optional(z.boolean()).default(false),
|
|
889
|
-
});
|
|
889
|
+
}).strict();
|
|
890
890
|
/**
|
|
891
891
|
* Send videos to TikTok. TikTok credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/tiktok), not in the request.
|
|
892
892
|
*/
|
|
893
893
|
export const tiktokDestinationTiktokDestinationSchema = z.object({
|
|
894
894
|
provider: z.literal("tiktok"),
|
|
895
895
|
options: z.optional(tiktokDestinationOptionsTiktokDestinationOptionsSchema),
|
|
896
|
-
});
|
|
896
|
+
}).strict();
|
|
897
897
|
/**
|
|
898
898
|
* Options to control the visibility of videos and privacy features.
|
|
899
899
|
*/
|
|
@@ -903,7 +903,7 @@ export const vimeoDestinationPrivacyOptionsVimeoDestinationPrivacyOptionsSchema
|
|
|
903
903
|
comments: z.optional(z.enum(["anybody", "nobody", "contacts"])),
|
|
904
904
|
download: z.optional(z.boolean()),
|
|
905
905
|
add: z.optional(z.boolean()),
|
|
906
|
-
});
|
|
906
|
+
}).strict();
|
|
907
907
|
export const vimeoDestinationPrivacyOptionsSchema = vimeoDestinationPrivacyOptionsVimeoDestinationPrivacyOptionsSchema;
|
|
908
908
|
/**
|
|
909
909
|
* Pass additional options to control how Vimeo publishes video, including name, description and privacy settings.
|
|
@@ -913,7 +913,7 @@ export const vimeoDestinationOptionsVimeoDestinationOptionsSchema = z.object({
|
|
|
913
913
|
description: z.optional(z.string()),
|
|
914
914
|
privacy: z.optional(vimeoDestinationPrivacyOptionsVimeoDestinationPrivacyOptionsSchema),
|
|
915
915
|
folderUri: z.optional(z.string()),
|
|
916
|
-
});
|
|
916
|
+
}).strict();
|
|
917
917
|
export const vimeoDestinationOptionsSchema = vimeoDestinationOptionsVimeoDestinationOptionsSchema;
|
|
918
918
|
/**
|
|
919
919
|
* Send videos to [Vimeo](https://shotstack.io/docs/guide/serving-assets/destinations/vimeo/) video hosting and streaming service. Vimeo credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/vimeo), not in the request.
|
|
@@ -921,7 +921,7 @@ export const vimeoDestinationOptionsSchema = vimeoDestinationOptionsVimeoDestina
|
|
|
921
921
|
export const vimeoDestinationVimeoDestinationSchema = z.object({
|
|
922
922
|
provider: z.literal("vimeo"),
|
|
923
923
|
options: z.optional(vimeoDestinationOptionsVimeoDestinationOptionsSchema),
|
|
924
|
-
});
|
|
924
|
+
}).strict();
|
|
925
925
|
export const vimeoDestinationSchema = vimeoDestinationVimeoDestinationSchema;
|
|
926
926
|
/**
|
|
927
927
|
* A destination is a location where assets can be sent to for serving or hosting. Videos, images and audio files that are rendered by the [Edit API](#shotstack-edit) and [source](#tocs_source) and [rendition](#tocs_rendition) files generated by the [Ingest API](#shotstack-ingest) can be sent to destinations. You can also fetch a file from any public URL and [transfer](#transfer-asset) it to a destination. A file can be sent to one or more destinations including 3rd party destinations.
|
|
@@ -944,14 +944,14 @@ export const destinationsSchema = destinationsDestinationsSchema;
|
|
|
944
944
|
export const fliptransformationFlipTransformationSchema = z.object({
|
|
945
945
|
horizontal: z.optional(z.boolean()),
|
|
946
946
|
vertical: z.optional(z.boolean()),
|
|
947
|
-
});
|
|
947
|
+
}).strict();
|
|
948
948
|
export const flipTransformationSchema = fliptransformationFlipTransformationSchema;
|
|
949
949
|
/**
|
|
950
950
|
* Download a custom font to use with the HTML asset type, using the font name in the CSS or font tag. See our [custom fonts](https://shotstack.io/learn/html-custom-fonts/) getting started guide for more details.
|
|
951
951
|
*/
|
|
952
952
|
export const fontFontSchema = z.object({
|
|
953
953
|
src: z.string(),
|
|
954
|
-
});
|
|
954
|
+
}).strict();
|
|
955
955
|
export const fontSchema = fontFontSchema;
|
|
956
956
|
/**
|
|
957
957
|
* **Notice: The HtmlAsset is deprecated, use the [TextAsset](#tocs_textasset) instead.**
|
|
@@ -993,7 +993,7 @@ export const htmlassetHtmlAssetSchema = z.object({
|
|
|
993
993
|
"topLeft",
|
|
994
994
|
"center",
|
|
995
995
|
])),
|
|
996
|
-
});
|
|
996
|
+
}).strict();
|
|
997
997
|
export const htmlAssetSchema = htmlassetHtmlAssetSchema;
|
|
998
998
|
/**
|
|
999
999
|
* The ImageAsset is used to create video from images to compose an image. The src must be a publicly accessible URL to an image resource such as a jpg or png file.
|
|
@@ -1002,7 +1002,7 @@ export const imageassetImageAssetSchema = z.object({
|
|
|
1002
1002
|
type: z.enum(["image"]),
|
|
1003
1003
|
src: z.string().min(1).regex(/\S/),
|
|
1004
1004
|
crop: z.optional(cropCropSchema),
|
|
1005
|
-
});
|
|
1005
|
+
}).strict();
|
|
1006
1006
|
export const imageAssetSchema = imageassetImageAssetSchema;
|
|
1007
1007
|
/**
|
|
1008
1008
|
* The ImageToVideoAsset lets you create a video from an image and a text prompt.
|
|
@@ -1020,7 +1020,7 @@ export const imagetovideoassetImageToVideoAssetSchema = z.object({
|
|
|
1020
1020
|
return Number(v);
|
|
1021
1021
|
} return v; }), z.number().gte(0).lte(10)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
|
|
1022
1022
|
crop: z.optional(cropCropSchema),
|
|
1023
|
-
});
|
|
1023
|
+
}).strict();
|
|
1024
1024
|
export const imageToVideoAssetSchema = imagetovideoassetImageToVideoAssetSchema;
|
|
1025
1025
|
/**
|
|
1026
1026
|
* Options for the Dolby.io audio enhancement provider.
|
|
@@ -1037,7 +1037,7 @@ export const dolbyEnhancementOptionsDolbyEnhancementOptionsSchema = z.object({
|
|
|
1037
1037
|
"studio",
|
|
1038
1038
|
"voice_over",
|
|
1039
1039
|
]),
|
|
1040
|
-
});
|
|
1040
|
+
}).strict();
|
|
1041
1041
|
export const dolbyEnhancementOptionsSchema = dolbyEnhancementOptionsDolbyEnhancementOptionsSchema;
|
|
1042
1042
|
/**
|
|
1043
1043
|
* Dolby.io audio enhancement provider. Credentials are required and must be added via the [dashboard](https://dashboard.shotstack.io/integrations/dolby), not in the request.
|
|
@@ -1045,7 +1045,7 @@ export const dolbyEnhancementOptionsSchema = dolbyEnhancementOptionsDolbyEnhance
|
|
|
1045
1045
|
export const dolbyEnhancementDolbyEnhancementSchema = z.object({
|
|
1046
1046
|
provider: z.string().default("dolby"),
|
|
1047
1047
|
options: dolbyEnhancementOptionsDolbyEnhancementOptionsSchema,
|
|
1048
|
-
});
|
|
1048
|
+
}).strict();
|
|
1049
1049
|
export const dolbyEnhancementSchema = dolbyEnhancementDolbyEnhancementSchema;
|
|
1050
1050
|
/**
|
|
1051
1051
|
* An audio enhancement that can be applied to the audio content of a rendition.
|
|
@@ -1064,7 +1064,7 @@ export const audioEnhancementSchema = audioEnhancementAudioEnhancementSchema;
|
|
|
1064
1064
|
*/
|
|
1065
1065
|
export const enhancementsEnhancementsSchema = z.object({
|
|
1066
1066
|
audio: z.optional(audioEnhancementAudioEnhancementSchema),
|
|
1067
|
-
});
|
|
1067
|
+
}).strict();
|
|
1068
1068
|
export const enhancementsSchema = enhancementsEnhancementsSchema;
|
|
1069
1069
|
/**
|
|
1070
1070
|
* Individual errors returned by the Ingest API.
|
|
@@ -1073,14 +1073,14 @@ export const ingesterrorresponsedataIngestErrorResponseDataSchema = z.object({
|
|
|
1073
1073
|
status: z.string(),
|
|
1074
1074
|
title: z.string(),
|
|
1075
1075
|
detail: z.string(),
|
|
1076
|
-
});
|
|
1076
|
+
}).strict();
|
|
1077
1077
|
export const ingestErrorResponseDataSchema = ingesterrorresponsedataIngestErrorResponseDataSchema;
|
|
1078
1078
|
/**
|
|
1079
1079
|
* Error response data for validation and other errors returned by the Ingest API.
|
|
1080
1080
|
*/
|
|
1081
1081
|
export const ingesterrorresponseIngestErrorResponseSchema = z.object({
|
|
1082
1082
|
errors: z.array(ingesterrorresponsedataIngestErrorResponseDataSchema),
|
|
1083
|
-
});
|
|
1083
|
+
}).strict();
|
|
1084
1084
|
export const ingestErrorResponseSchema = ingesterrorresponseIngestErrorResponseSchema;
|
|
1085
1085
|
/**
|
|
1086
1086
|
* The type of resource (a source) and the newly created source id. Returned with [QueuedSourceResponse](#tocs_queuedsourceresponse).
|
|
@@ -1088,14 +1088,14 @@ export const ingestErrorResponseSchema = ingesterrorresponseIngestErrorResponseS
|
|
|
1088
1088
|
export const queuedsourceresponsedataQueuedSourceResponseDataSchema = z.object({
|
|
1089
1089
|
type: z.string(),
|
|
1090
1090
|
id: z.string(),
|
|
1091
|
-
});
|
|
1091
|
+
}).strict();
|
|
1092
1092
|
export const queuedSourceResponseDataSchema = queuedsourceresponsedataQueuedSourceResponseDataSchema;
|
|
1093
1093
|
/**
|
|
1094
1094
|
* The response returned by the Ingest API [fetch source](#fetch-source) request. Includes the id of the source file. The response follows the [json:api](https://jsonapi.org/) specification.
|
|
1095
1095
|
*/
|
|
1096
1096
|
export const queuedsourceresponseQueuedSourceResponseSchema = z.object({
|
|
1097
1097
|
data: queuedsourceresponsedataQueuedSourceResponseDataSchema,
|
|
1098
|
-
});
|
|
1098
|
+
}).strict();
|
|
1099
1099
|
export const queuedSourceResponseSchema = queuedsourceresponseQueuedSourceResponseSchema;
|
|
1100
1100
|
/**
|
|
1101
1101
|
* The id and attributes of the upload file including the signed URL to send the binary file data to.
|
|
@@ -1104,7 +1104,7 @@ export const uploadresponseattributesUploadResponseAttributesSchema = z.object({
|
|
|
1104
1104
|
id: z.string(),
|
|
1105
1105
|
url: z.string(),
|
|
1106
1106
|
expires: z.string(),
|
|
1107
|
-
});
|
|
1107
|
+
}).strict();
|
|
1108
1108
|
export const uploadResponseAttributesSchema = uploadresponseattributesUploadResponseAttributesSchema;
|
|
1109
1109
|
/**
|
|
1110
1110
|
* The type of resource (an upload), it's id and attributes of the upload request.
|
|
@@ -1113,14 +1113,14 @@ export const uploadresponsedataUploadResponseDataSchema = z.object({
|
|
|
1113
1113
|
type: z.string(),
|
|
1114
1114
|
id: z.string(),
|
|
1115
1115
|
attributes: uploadresponseattributesUploadResponseAttributesSchema,
|
|
1116
|
-
});
|
|
1116
|
+
}).strict();
|
|
1117
1117
|
export const uploadResponseDataSchema = uploadresponsedataUploadResponseDataSchema;
|
|
1118
1118
|
/**
|
|
1119
1119
|
* The response returned by the Ingest API [direct upload](#direct-upload) request. Includes the id of the file and the signed url to send the binary file to. The response follows the [json:api](https://jsonapi.org/) specification.
|
|
1120
1120
|
*/
|
|
1121
1121
|
export const uploadresponseUploadResponseSchema = z.object({
|
|
1122
1122
|
data: uploadresponsedataUploadResponseDataSchema,
|
|
1123
|
-
});
|
|
1123
|
+
}).strict();
|
|
1124
1124
|
export const uploadResponseSchema = uploadresponseUploadResponseSchema;
|
|
1125
1125
|
/**
|
|
1126
1126
|
* Set the playback speed of a video or audio file. Allows you to preserve the pitch of the audio so that it is sped up without sounding too high pitched or too low.
|
|
@@ -1134,14 +1134,14 @@ export const speedSpeedSchema = z.object({
|
|
|
1134
1134
|
return Number(v);
|
|
1135
1135
|
} return v; }), z.number().gte(0).lte(10)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
|
|
1136
1136
|
preservePitch: z.optional(z.boolean()),
|
|
1137
|
-
});
|
|
1137
|
+
}).strict();
|
|
1138
1138
|
export const speedSchema = speedSpeedSchema;
|
|
1139
1139
|
/**
|
|
1140
1140
|
* Generate a transcription of the audio in the video. The transcription can be output as a file in SRT or VTT format.
|
|
1141
1141
|
*/
|
|
1142
1142
|
export const transcriptionTranscriptionSchema = z.object({
|
|
1143
1143
|
format: z.optional(z.enum(["srt", "vtt"])),
|
|
1144
|
-
});
|
|
1144
|
+
}).strict();
|
|
1145
1145
|
export const transcriptionSchema = transcriptionTranscriptionSchema;
|
|
1146
1146
|
/**
|
|
1147
1147
|
* The LumaAsset is used to create luma matte masks, transitions and effects between other assets. A luma matte is a grey scale image or animated video where the black areas are transparent and the white areas solid. The luma matte animation should be provided as an mp4 video file. The src must be a publicly accessible URL to the file.
|
|
@@ -1156,7 +1156,7 @@ export const lumaassetLumaAssetSchema = z.object({
|
|
|
1156
1156
|
return v;
|
|
1157
1157
|
return Number(v);
|
|
1158
1158
|
} return v; }), z.number()), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
|
|
1159
|
-
});
|
|
1159
|
+
}).strict();
|
|
1160
1160
|
export const lumaAssetSchema = lumaassetLumaAssetSchema;
|
|
1161
1161
|
/**
|
|
1162
1162
|
* A merge field consists of a key; `find`, and a value; `replace`. Merge fields can be used to replace placeholders within the JSON edit to create re-usable templates. Placeholders should be a string with double brace delimiters, i.e. `"{{NAME}}"`. A placeholder can be used for any value within the JSON edit.
|
|
@@ -1164,7 +1164,7 @@ export const lumaAssetSchema = lumaassetLumaAssetSchema;
|
|
|
1164
1164
|
export const mergefieldMergeFieldSchema = z.object({
|
|
1165
1165
|
find: z.string(),
|
|
1166
1166
|
replace: z.union([z.string(), z.number(), z.boolean(), z.null(), z.record(z.string(), z.unknown()), z.array(z.unknown())]),
|
|
1167
|
-
});
|
|
1167
|
+
}).strict();
|
|
1168
1168
|
export const mergeFieldSchema = mergefieldMergeFieldSchema;
|
|
1169
1169
|
/**
|
|
1170
1170
|
* Generate a poster image for the video at a specific point from the timeline. The poster image size will match the size of the output video.
|
|
@@ -1177,7 +1177,7 @@ export const posterPosterSchema = z.object({
|
|
|
1177
1177
|
return v;
|
|
1178
1178
|
return Number(v);
|
|
1179
1179
|
} return v; }), z.number()), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]),
|
|
1180
|
-
});
|
|
1180
|
+
}).strict();
|
|
1181
1181
|
export const posterSchema = posterPosterSchema;
|
|
1182
1182
|
/**
|
|
1183
1183
|
* Specify a time range to render, i.e. to render only a portion of a video or audio file. Omit this setting to export the entire video. Range can also be used to render a frame at a specific time point - setting a range and output format as `jpg` will output a single frame image at the range `start` point.
|
|
@@ -1197,7 +1197,7 @@ export const rangeRangeSchema = z.object({
|
|
|
1197
1197
|
return v;
|
|
1198
1198
|
return Number(v);
|
|
1199
1199
|
} return v; }), z.number().gte(0)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
|
|
1200
|
-
});
|
|
1200
|
+
}).strict();
|
|
1201
1201
|
export const rangeSchema = rangeRangeSchema;
|
|
1202
1202
|
/**
|
|
1203
1203
|
* The list of asset attributes and their values.
|
|
@@ -1213,7 +1213,7 @@ export const assetresponseattributesAssetResponseAttributesSchema = z.object({
|
|
|
1213
1213
|
status: z.enum(["importing", "ready", "failed", "deleted"]),
|
|
1214
1214
|
created: z.optional(z.string()),
|
|
1215
1215
|
updated: z.optional(z.string()),
|
|
1216
|
-
});
|
|
1216
|
+
}).strict();
|
|
1217
1217
|
export const assetResponseAttributesSchema = assetresponseattributesAssetResponseAttributesSchema;
|
|
1218
1218
|
/**
|
|
1219
1219
|
* The type of resource (an asset) and attributes of the asset.
|
|
@@ -1221,21 +1221,21 @@ export const assetResponseAttributesSchema = assetresponseattributesAssetRespons
|
|
|
1221
1221
|
export const assetresponsedataAssetResponseDataSchema = z.object({
|
|
1222
1222
|
type: z.string(),
|
|
1223
1223
|
attributes: assetresponseattributesAssetResponseAttributesSchema,
|
|
1224
|
-
});
|
|
1224
|
+
}).strict();
|
|
1225
1225
|
export const assetResponseDataSchema = assetresponsedataAssetResponseDataSchema;
|
|
1226
1226
|
/**
|
|
1227
1227
|
* The response returned by the Serve API [get asset by render id](#get-asset-by-render-id) request. The response is an array of asset resources, including video, image, audio, thumbnail and poster image. The response follows the [json:api](https://jsonapi.org/) specification.
|
|
1228
1228
|
*/
|
|
1229
1229
|
export const assetrenderresponseAssetRenderResponseSchema = z.object({
|
|
1230
1230
|
data: z.array(assetresponsedataAssetResponseDataSchema),
|
|
1231
|
-
});
|
|
1231
|
+
}).strict();
|
|
1232
1232
|
export const assetRenderResponseSchema = assetrenderresponseAssetRenderResponseSchema;
|
|
1233
1233
|
/**
|
|
1234
1234
|
* The response returned by the Serve API [get asset](#get-asset) request. Includes details of a hosted video, image, audio file, thumbnail or poster image. The response follows the [json:api](https://jsonapi.org/) specification.
|
|
1235
1235
|
*/
|
|
1236
1236
|
export const assetresponseAssetResponseSchema = z.object({
|
|
1237
1237
|
data: assetresponsedataAssetResponseDataSchema,
|
|
1238
|
-
});
|
|
1238
|
+
}).strict();
|
|
1239
1239
|
export const assetResponseSchema = assetresponseAssetResponseSchema;
|
|
1240
1240
|
/**
|
|
1241
1241
|
* The response received after a [probe request](#inspect-media) is submitted. The probe requests returns data from FFprobe formatted as JSON.
|
|
@@ -1244,7 +1244,7 @@ export const proberesponseProbeResponseSchema = z.object({
|
|
|
1244
1244
|
success: z.boolean(),
|
|
1245
1245
|
message: z.string(),
|
|
1246
1246
|
response: z.record(z.string(), z.unknown()),
|
|
1247
|
-
});
|
|
1247
|
+
}).strict();
|
|
1248
1248
|
export const probeResponseSchema = proberesponseProbeResponseSchema;
|
|
1249
1249
|
/**
|
|
1250
1250
|
* The response data returned with the [QueuedResponse](#tocs_queuedresponse).
|
|
@@ -1252,7 +1252,7 @@ export const probeResponseSchema = proberesponseProbeResponseSchema;
|
|
|
1252
1252
|
export const queuedresponsedataQueuedResponseDataSchema = z.object({
|
|
1253
1253
|
message: z.string(),
|
|
1254
1254
|
id: z.string(),
|
|
1255
|
-
});
|
|
1255
|
+
}).strict();
|
|
1256
1256
|
export const queuedResponseDataSchema = queuedresponsedataQueuedResponseDataSchema;
|
|
1257
1257
|
/**
|
|
1258
1258
|
* The response received after a [render request](#render-asset) or [template render](#render-template) is submitted. The render task is queued for rendering and a unique render id is returned.
|
|
@@ -1261,7 +1261,7 @@ export const queuedresponseQueuedResponseSchema = z.object({
|
|
|
1261
1261
|
success: z.boolean(),
|
|
1262
1262
|
message: z.string(),
|
|
1263
1263
|
response: queuedresponsedataQueuedResponseDataSchema,
|
|
1264
|
-
});
|
|
1264
|
+
}).strict();
|
|
1265
1265
|
export const queuedResponseSchema = queuedresponseQueuedResponseSchema;
|
|
1266
1266
|
/**
|
|
1267
1267
|
* The individual template item returned with the [TemplateListResponseData](#tocs_templatelistresponsedata) templates list.
|
|
@@ -1271,7 +1271,7 @@ export const templatelistresponseitemTemplateListResponseItemSchema = z.object({
|
|
|
1271
1271
|
name: z.string(),
|
|
1272
1272
|
created: z.optional(z.string()),
|
|
1273
1273
|
updated: z.optional(z.string()),
|
|
1274
|
-
});
|
|
1274
|
+
}).strict();
|
|
1275
1275
|
export const templateListResponseItemSchema = templatelistresponseitemTemplateListResponseItemSchema;
|
|
1276
1276
|
/**
|
|
1277
1277
|
* The response data returned with the [TemplateListResponse](#tocs_templatelistresponse).
|
|
@@ -1279,7 +1279,7 @@ export const templateListResponseItemSchema = templatelistresponseitemTemplateLi
|
|
|
1279
1279
|
export const templatelistresponsedataTemplateListResponseDataSchema = z.object({
|
|
1280
1280
|
owner: z.string(),
|
|
1281
1281
|
templates: z.array(templatelistresponseitemTemplateListResponseItemSchema),
|
|
1282
|
-
});
|
|
1282
|
+
}).strict();
|
|
1283
1283
|
export const templateListResponseDataSchema = templatelistresponsedataTemplateListResponseDataSchema;
|
|
1284
1284
|
/**
|
|
1285
1285
|
* A list of previously saved templates.
|
|
@@ -1288,7 +1288,7 @@ export const templatelistresponseTemplateListResponseSchema = z.object({
|
|
|
1288
1288
|
success: z.boolean(),
|
|
1289
1289
|
message: z.string(),
|
|
1290
1290
|
response: templatelistresponsedataTemplateListResponseDataSchema,
|
|
1291
|
-
});
|
|
1291
|
+
}).strict();
|
|
1292
1292
|
export const templateListResponseSchema = templatelistresponseTemplateListResponseSchema;
|
|
1293
1293
|
/**
|
|
1294
1294
|
* The response data returned with the [TemplateResponse](#tocs_templateresponse).
|
|
@@ -1296,7 +1296,7 @@ export const templateListResponseSchema = templatelistresponseTemplateListRespon
|
|
|
1296
1296
|
export const templateresponsedataTemplateResponseDataSchema = z.object({
|
|
1297
1297
|
message: z.string(),
|
|
1298
1298
|
id: z.string(),
|
|
1299
|
-
});
|
|
1299
|
+
}).strict();
|
|
1300
1300
|
export const templateResponseDataSchema = templateresponsedataTemplateResponseDataSchema;
|
|
1301
1301
|
/**
|
|
1302
1302
|
* The response received after a [template](#create-template) is submitted. The template is saved and a unique template id is returned.
|
|
@@ -1305,7 +1305,7 @@ export const templateresponseTemplateResponseSchema = z.object({
|
|
|
1305
1305
|
success: z.boolean(),
|
|
1306
1306
|
message: z.string(),
|
|
1307
1307
|
response: templateresponsedataTemplateResponseDataSchema,
|
|
1308
|
-
});
|
|
1308
|
+
}).strict();
|
|
1309
1309
|
export const templateResponseSchema = templateresponseTemplateResponseSchema;
|
|
1310
1310
|
/**
|
|
1311
1311
|
* Font properties for the active/highlighted word.
|
|
@@ -1320,7 +1320,7 @@ export const richcaptionpropertiesRichCaptionActiveFontSchema = z.object({
|
|
|
1320
1320
|
return v;
|
|
1321
1321
|
return Number(v);
|
|
1322
1322
|
} return v; }), z.number().gte(0).lte(1)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(1),
|
|
1323
|
-
});
|
|
1323
|
+
}).strict();
|
|
1324
1324
|
export const richCaptionActiveFontSchema = richcaptionpropertiesRichCaptionActiveFontSchema;
|
|
1325
1325
|
/**
|
|
1326
1326
|
* Word-level animation properties for caption effects.
|
|
@@ -1344,7 +1344,7 @@ export const richcaptionpropertiesRichCaptionWordAnimationSchema = z.object({
|
|
|
1344
1344
|
return Number(v);
|
|
1345
1345
|
} return v; }), z.number().gte(0.5).lte(2)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(1),
|
|
1346
1346
|
direction: z.optional(z.enum(["left", "right", "up", "down"])),
|
|
1347
|
-
});
|
|
1347
|
+
}).strict();
|
|
1348
1348
|
export const richCaptionWordAnimationSchema = richcaptionpropertiesRichCaptionWordAnimationSchema;
|
|
1349
1349
|
/**
|
|
1350
1350
|
* Word-level timing information for caption animation.
|
|
@@ -1372,7 +1372,7 @@ export const richcaptionpropertiesWordTimingSchema = z.object({
|
|
|
1372
1372
|
return v;
|
|
1373
1373
|
return Number(v);
|
|
1374
1374
|
} return v; }), z.number().gte(0).lte(1)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
|
|
1375
|
-
});
|
|
1375
|
+
}).strict();
|
|
1376
1376
|
export const wordTimingSchema = richcaptionpropertiesWordTimingSchema;
|
|
1377
1377
|
/**
|
|
1378
1378
|
* Text alignment properties (horizontal and vertical).
|
|
@@ -1380,7 +1380,7 @@ export const wordTimingSchema = richcaptionpropertiesWordTimingSchema;
|
|
|
1380
1380
|
export const richtextpropertiesRichTextAlignmentSchema = z.object({
|
|
1381
1381
|
horizontal: z.optional(z.enum(["left", "center", "right"])),
|
|
1382
1382
|
vertical: z.optional(z.enum(["top", "middle", "bottom"])),
|
|
1383
|
-
});
|
|
1383
|
+
}).strict();
|
|
1384
1384
|
export const richTextAlignmentSchema = richtextpropertiesRichTextAlignmentSchema;
|
|
1385
1385
|
/**
|
|
1386
1386
|
* Animation properties for text entrance effects.
|
|
@@ -1403,7 +1403,7 @@ export const richtextpropertiesRichTextAnimationSchema = z.object({
|
|
|
1403
1403
|
} return v; }), z.number().gte(0.1).lte(30)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
|
|
1404
1404
|
style: z.optional(z.enum(["character", "word"])),
|
|
1405
1405
|
direction: z.optional(z.enum(["left", "right", "up", "down"])),
|
|
1406
|
-
});
|
|
1406
|
+
}).strict();
|
|
1407
1407
|
export const richTextAnimationSchema = richtextpropertiesRichTextAnimationSchema;
|
|
1408
1408
|
/**
|
|
1409
1409
|
* Background styling properties for the text bounding box.
|
|
@@ -1424,7 +1424,7 @@ export const richtextpropertiesRichTextBackgroundSchema = z.object({
|
|
|
1424
1424
|
return v;
|
|
1425
1425
|
return Number(v);
|
|
1426
1426
|
} return v; }), z.number().gte(0)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(0),
|
|
1427
|
-
});
|
|
1427
|
+
}).strict();
|
|
1428
1428
|
export const richTextBackgroundSchema = richtextpropertiesRichTextBackgroundSchema;
|
|
1429
1429
|
/**
|
|
1430
1430
|
* Border styling properties for the text bounding box.
|
|
@@ -1452,7 +1452,7 @@ export const richtextpropertiesRichTextBorderSchema = z.object({
|
|
|
1452
1452
|
return v;
|
|
1453
1453
|
return Number(v);
|
|
1454
1454
|
} return v; }), z.number().gte(0)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(0),
|
|
1455
|
-
});
|
|
1455
|
+
}).strict();
|
|
1456
1456
|
/**
|
|
1457
1457
|
* Gradient properties for text fill.
|
|
1458
1458
|
*/
|
|
@@ -1477,7 +1477,7 @@ export const richtextpropertiesRichTextGradientSchema = z.object({
|
|
|
1477
1477
|
color: z.union([z.string().regex(/^#[A-Fa-f0-9]{6}$/), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]),
|
|
1478
1478
|
}))
|
|
1479
1479
|
.min(2),
|
|
1480
|
-
});
|
|
1480
|
+
}).strict();
|
|
1481
1481
|
export const richTextGradientSchema = richtextpropertiesRichTextGradientSchema;
|
|
1482
1482
|
/**
|
|
1483
1483
|
* Padding properties for individual sides of the text bounding box.
|
|
@@ -1511,7 +1511,7 @@ export const richtextpropertiesRichTextPaddingSchema = z.object({
|
|
|
1511
1511
|
return v;
|
|
1512
1512
|
return Number(v);
|
|
1513
1513
|
} return v; }), z.number().gte(0)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(0),
|
|
1514
|
-
});
|
|
1514
|
+
}).strict();
|
|
1515
1515
|
/**
|
|
1516
1516
|
* Text shadow properties.
|
|
1517
1517
|
*/
|
|
@@ -1545,7 +1545,7 @@ export const richtextpropertiesRichTextShadowSchema = z.object({
|
|
|
1545
1545
|
return v;
|
|
1546
1546
|
return Number(v);
|
|
1547
1547
|
} return v; }), z.number().gte(0).lte(1)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(0.5),
|
|
1548
|
-
});
|
|
1548
|
+
}).strict();
|
|
1549
1549
|
export const richTextShadowSchema = richtextpropertiesRichTextShadowSchema;
|
|
1550
1550
|
/**
|
|
1551
1551
|
* Text stroke (outline) properties.
|
|
@@ -1566,7 +1566,7 @@ export const richtextpropertiesRichTextStrokeSchema = z.object({
|
|
|
1566
1566
|
return v;
|
|
1567
1567
|
return Number(v);
|
|
1568
1568
|
} return v; }), z.number().gte(0).lte(1)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(1),
|
|
1569
|
-
});
|
|
1569
|
+
}).strict();
|
|
1570
1570
|
export const richTextStrokeSchema = richtextpropertiesRichTextStrokeSchema;
|
|
1571
1571
|
/**
|
|
1572
1572
|
* Styling properties for the active/highlighted word.
|
|
@@ -1581,7 +1581,7 @@ export const richcaptionpropertiesRichCaptionActiveSchema = z.object({
|
|
|
1581
1581
|
return v;
|
|
1582
1582
|
return Number(v);
|
|
1583
1583
|
} return v; }), z.number().gte(0.5).lte(2)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(1),
|
|
1584
|
-
});
|
|
1584
|
+
}).strict();
|
|
1585
1585
|
export const richCaptionActiveSchema = richcaptionpropertiesRichCaptionActiveSchema;
|
|
1586
1586
|
/**
|
|
1587
1587
|
* Font properties for rich text.
|
|
@@ -1606,7 +1606,7 @@ export const richtextpropertiesRichTextFontSchema = z.object({
|
|
|
1606
1606
|
} return v; }), z.number().gte(0).lte(1)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(1),
|
|
1607
1607
|
background: z.optional(z.union([z.string().regex(/^#[A-Fa-f0-9]{6}$/), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
|
|
1608
1608
|
stroke: z.optional(richtextpropertiesRichTextStrokeSchema),
|
|
1609
|
-
});
|
|
1609
|
+
}).strict();
|
|
1610
1610
|
export const richTextFontSchema = richtextpropertiesRichTextFontSchema;
|
|
1611
1611
|
/**
|
|
1612
1612
|
* Text style properties including spacing, line height, and transformations.
|
|
@@ -1636,7 +1636,7 @@ export const richtextpropertiesRichTextStyleSchema = z.object({
|
|
|
1636
1636
|
textTransform: z.optional(z.enum(["none", "uppercase", "lowercase", "capitalize"])),
|
|
1637
1637
|
textDecoration: z.optional(z.enum(["none", "underline", "line-through"])),
|
|
1638
1638
|
gradient: z.optional(richtextpropertiesRichTextGradientSchema),
|
|
1639
|
-
});
|
|
1639
|
+
}).strict();
|
|
1640
1640
|
export const richTextStyleSchema = richtextpropertiesRichTextStyleSchema;
|
|
1641
1641
|
/**
|
|
1642
1642
|
* The RichCaptionAsset provides word-level caption animations with rich-text styling. It supports
|
|
@@ -1678,7 +1678,7 @@ export const richcaptionassetRichCaptionAssetSchema = z.object({
|
|
|
1678
1678
|
return v;
|
|
1679
1679
|
return Number(v);
|
|
1680
1680
|
} return v; }), z.number().int().gte(1).lte(10)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(2),
|
|
1681
|
-
});
|
|
1681
|
+
}).strict();
|
|
1682
1682
|
export const richCaptionAssetSchema = richcaptionassetRichCaptionAssetSchema;
|
|
1683
1683
|
/**
|
|
1684
1684
|
* The RichTextAsset provides advanced text rendering with support for custom fonts, gradients, shadows, strokes,
|
|
@@ -1703,7 +1703,7 @@ export const richtextassetRichTextAssetSchema = z.object({
|
|
|
1703
1703
|
} return v; }), z.number().gte(0)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]), richtextpropertiesRichTextPaddingSchema])),
|
|
1704
1704
|
align: z.optional(richtextpropertiesRichTextAlignmentSchema),
|
|
1705
1705
|
animation: z.optional(richtextpropertiesRichTextAnimationSchema),
|
|
1706
|
-
});
|
|
1706
|
+
}).strict();
|
|
1707
1707
|
export const richTextAssetSchema = richtextassetRichTextAssetSchema;
|
|
1708
1708
|
/**
|
|
1709
1709
|
* The transfer request attributes inlcudling the user specified ID and status. Returned with [TransferResponseData](#tocs_transferresponsedata).
|
|
@@ -1713,7 +1713,7 @@ export const transferresponseattributesTransferResponseAttributesSchema = z.obje
|
|
|
1713
1713
|
owner: z.optional(z.string()),
|
|
1714
1714
|
status: z.optional(z.enum(["queued", "failed"])),
|
|
1715
1715
|
created: z.optional(z.string()),
|
|
1716
|
-
});
|
|
1716
|
+
}).strict();
|
|
1717
1717
|
export const transferResponseAttributesSchema = transferresponseattributesTransferResponseAttributesSchema;
|
|
1718
1718
|
/**
|
|
1719
1719
|
* The type of resource (an asset) and the transfer attributes. Returned with [TransferResponse](#tocs_transferresponse).
|
|
@@ -1721,14 +1721,14 @@ export const transferResponseAttributesSchema = transferresponseattributesTransf
|
|
|
1721
1721
|
export const transferresponsedataTransferResponseDataSchema = z.object({
|
|
1722
1722
|
type: z.optional(z.string()),
|
|
1723
1723
|
attributes: z.optional(transferresponseattributesTransferResponseAttributesSchema),
|
|
1724
|
-
});
|
|
1724
|
+
}).strict();
|
|
1725
1725
|
export const transferResponseDataSchema = transferresponsedataTransferResponseDataSchema;
|
|
1726
1726
|
/**
|
|
1727
1727
|
* The response returned by the Serve API [transfer asset](#transfer-asset) request. The response includes the ID and transfer status. The response follows the [json:api](https://jsonapi.org/) specification.
|
|
1728
1728
|
*/
|
|
1729
1729
|
export const transferresponseTransferResponseSchema = z.object({
|
|
1730
1730
|
data: transferresponsedataTransferResponseDataSchema,
|
|
1731
|
-
});
|
|
1731
|
+
}).strict();
|
|
1732
1732
|
export const transferResponseSchema = transferresponseTransferResponseSchema;
|
|
1733
1733
|
/**
|
|
1734
1734
|
* The asset URL to fetch and transfer to a destination.
|
|
@@ -1737,7 +1737,7 @@ export const transferTransferSchema = z.object({
|
|
|
1737
1737
|
url: z.string(),
|
|
1738
1738
|
id: z.string(),
|
|
1739
1739
|
destinations: z.array(destinationsDestinationsSchema),
|
|
1740
|
-
});
|
|
1740
|
+
}).strict();
|
|
1741
1741
|
export const transferSchema = transferTransferSchema;
|
|
1742
1742
|
/**
|
|
1743
1743
|
* The ShapeAsset is used to add shapes to a video. The shape can be styled with a fill and a stroke.
|
|
@@ -1829,7 +1829,7 @@ export const shapeassetShapeAssetSchema = z.object({
|
|
|
1829
1829
|
return Number(v);
|
|
1830
1830
|
} return v; }), z.number().int()), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]),
|
|
1831
1831
|
})),
|
|
1832
|
-
});
|
|
1832
|
+
}).strict();
|
|
1833
1833
|
export const shapeAssetSchema = shapeassetShapeAssetSchema;
|
|
1834
1834
|
/**
|
|
1835
1835
|
* Set a custom size for a video or image in pixels. When using a custom size omit the `resolution` and `aspectRatio`. Custom sizes must be divisible by 2 based on the encoder specifications.
|
|
@@ -1849,7 +1849,7 @@ export const sizeSizeSchema = z.object({
|
|
|
1849
1849
|
return v;
|
|
1850
1850
|
return Number(v);
|
|
1851
1851
|
} return v; }), z.number().int().gte(1).lte(4096)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
|
|
1852
|
-
});
|
|
1852
|
+
}).strict();
|
|
1853
1853
|
export const sizeSchema = sizeSizeSchema;
|
|
1854
1854
|
/**
|
|
1855
1855
|
* A rendition is a new output file that is generated from the source. The rendition can be encoded to a different format and have transformations applied to it such as resizing, cropping, etc...
|
|
@@ -1907,7 +1907,7 @@ export const renditionRenditionSchema = z.object({
|
|
|
1907
1907
|
fixRotation: z.optional(z.boolean()),
|
|
1908
1908
|
enhance: z.optional(enhancementsEnhancementsSchema),
|
|
1909
1909
|
filename: z.optional(z.string()),
|
|
1910
|
-
});
|
|
1910
|
+
}).strict();
|
|
1911
1911
|
export const renditionSchema = renditionRenditionSchema;
|
|
1912
1912
|
/**
|
|
1913
1913
|
* The output renditions and transformations that should be generated from the source file.
|
|
@@ -1915,7 +1915,7 @@ export const renditionSchema = renditionRenditionSchema;
|
|
|
1915
1915
|
export const outputsOutputsSchema = z.object({
|
|
1916
1916
|
renditions: z.optional(z.array(renditionRenditionSchema)),
|
|
1917
1917
|
transcription: z.optional(transcriptionTranscriptionSchema),
|
|
1918
|
-
});
|
|
1918
|
+
}).strict();
|
|
1919
1919
|
export const outputsSchema = outputsOutputsSchema;
|
|
1920
1920
|
/**
|
|
1921
1921
|
* The id and attributes of the generated rendition file.
|
|
@@ -1967,14 +1967,14 @@ export const renditionresponseattributesRenditionResponseAttributesSchema = z.ob
|
|
|
1967
1967
|
return v;
|
|
1968
1968
|
return Number(v);
|
|
1969
1969
|
} return v; }), z.number()), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
|
|
1970
|
-
});
|
|
1970
|
+
}).strict();
|
|
1971
1971
|
export const renditionResponseAttributesSchema = renditionresponseattributesRenditionResponseAttributesSchema;
|
|
1972
1972
|
/**
|
|
1973
1973
|
* The list of outputs generated from the source file. Currently supports renditions which are versions of the source file with different transformations applied.
|
|
1974
1974
|
*/
|
|
1975
1975
|
export const outputsresponseOutputsResponseSchema = z.object({
|
|
1976
1976
|
renditions: z.optional(z.array(renditionresponseattributesRenditionResponseAttributesSchema)),
|
|
1977
|
-
});
|
|
1977
|
+
}).strict();
|
|
1978
1978
|
export const outputsResponseSchema = outputsresponseOutputsResponseSchema;
|
|
1979
1979
|
/**
|
|
1980
1980
|
* The id and attributes of the source file.
|
|
@@ -2023,7 +2023,7 @@ export const sourceresponseattributesSourceResponseAttributesSchema = z.object({
|
|
|
2023
2023
|
} return v; }), z.number()), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
|
|
2024
2024
|
created: z.optional(z.string()),
|
|
2025
2025
|
updated: z.optional(z.string()),
|
|
2026
|
-
});
|
|
2026
|
+
}).strict();
|
|
2027
2027
|
export const sourceResponseAttributesSchema = sourceresponseattributesSourceResponseAttributesSchema;
|
|
2028
2028
|
/**
|
|
2029
2029
|
* The type of resource (a source), it's id and attributes of the source file.
|
|
@@ -2032,21 +2032,21 @@ export const sourceresponsedataSourceResponseDataSchema = z.object({
|
|
|
2032
2032
|
type: z.string(),
|
|
2033
2033
|
id: z.string(),
|
|
2034
2034
|
attributes: sourceresponseattributesSourceResponseAttributesSchema,
|
|
2035
|
-
});
|
|
2035
|
+
}).strict();
|
|
2036
2036
|
export const sourceResponseDataSchema = sourceresponsedataSourceResponseDataSchema;
|
|
2037
2037
|
/**
|
|
2038
2038
|
* A list of all ingested source files fetched or uploaded to a users account.
|
|
2039
2039
|
*/
|
|
2040
2040
|
export const sourcelistresponseSourceListResponseSchema = z.object({
|
|
2041
2041
|
data: z.array(sourceresponsedataSourceResponseDataSchema),
|
|
2042
|
-
});
|
|
2042
|
+
}).strict();
|
|
2043
2043
|
export const sourceListResponseSchema = sourcelistresponseSourceListResponseSchema;
|
|
2044
2044
|
/**
|
|
2045
2045
|
* The response returned by the Ingest API [get source](#get-source) request. Includes details of the ingested source file. The response follows the [json:api](https://jsonapi.org/) specification.
|
|
2046
2046
|
*/
|
|
2047
2047
|
export const sourceresponseSourceResponseSchema = z.object({
|
|
2048
2048
|
data: sourceresponsedataSourceResponseDataSchema,
|
|
2049
|
-
});
|
|
2049
|
+
}).strict();
|
|
2050
2050
|
export const sourceResponseSchema = sourceresponseSourceResponseSchema;
|
|
2051
2051
|
/**
|
|
2052
2052
|
* The details of the file to be ingested and any transformations to be applied. Once the source file has been ingested, new renditions can be created from it. The renditions are specified in the **outputs** property.
|
|
@@ -2057,7 +2057,7 @@ export const sourceSourceSchema = z.object({
|
|
|
2057
2057
|
outputs: z.optional(outputsOutputsSchema),
|
|
2058
2058
|
destinations: z.optional(destinationsDestinationsSchema),
|
|
2059
2059
|
callback: z.optional(z.string()),
|
|
2060
|
-
});
|
|
2060
|
+
}).strict();
|
|
2061
2061
|
export const sourceSchema = sourceSourceSchema;
|
|
2062
2062
|
/**
|
|
2063
2063
|
* A music or audio file in mp3 format that plays for the duration of the rendered video or the length of the audio file, which ever is shortest.
|
|
@@ -2072,7 +2072,7 @@ export const soundtrackSoundtrackSchema = z.object({
|
|
|
2072
2072
|
return v;
|
|
2073
2073
|
return Number(v);
|
|
2074
2074
|
} return v; }), z.number()), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
|
|
2075
|
-
});
|
|
2075
|
+
}).strict();
|
|
2076
2076
|
export const soundtrackSchema = soundtrackSoundtrackSchema;
|
|
2077
2077
|
/**
|
|
2078
2078
|
* A color stop in a gradient. Each stop defines a color at a specific position
|
|
@@ -2088,7 +2088,7 @@ export const svgpropertiesSvgGradientStopSchema = z.object({
|
|
|
2088
2088
|
return Number(v);
|
|
2089
2089
|
} return v; }), z.number().gte(0).lte(1)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]),
|
|
2090
2090
|
color: z.union([z.string().regex(/^#[A-Fa-f0-9]{6}$/), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]),
|
|
2091
|
-
});
|
|
2091
|
+
}).strict();
|
|
2092
2092
|
export const svgGradientStopSchema = svgpropertiesSvgGradientStopSchema;
|
|
2093
2093
|
/**
|
|
2094
2094
|
* A linear gradient fill that transitions colors along a straight line.
|
|
@@ -2112,7 +2112,7 @@ export const svgpropertiesSvgLinearGradientFillSchema = z.object({
|
|
|
2112
2112
|
return v;
|
|
2113
2113
|
return Number(v);
|
|
2114
2114
|
} return v; }), z.number().gte(0).lte(1)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(1),
|
|
2115
|
-
});
|
|
2115
|
+
}).strict();
|
|
2116
2116
|
export const svgLinearGradientFillSchema = svgpropertiesSvgLinearGradientFillSchema;
|
|
2117
2117
|
/**
|
|
2118
2118
|
* A radial gradient fill that transitions colors radiating outward from a center point.
|
|
@@ -2129,7 +2129,7 @@ export const svgpropertiesSvgRadialGradientFillSchema = z.object({
|
|
|
2129
2129
|
return v;
|
|
2130
2130
|
return Number(v);
|
|
2131
2131
|
} return v; }), z.number().gte(0).lte(1)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(1),
|
|
2132
|
-
});
|
|
2132
|
+
}).strict();
|
|
2133
2133
|
export const svgRadialGradientFillSchema = svgpropertiesSvgRadialGradientFillSchema;
|
|
2134
2134
|
/**
|
|
2135
2135
|
* Drop shadow properties for SVG shapes. Creates a shadow effect behind the shape.
|
|
@@ -2165,7 +2165,7 @@ export const svgpropertiesSvgShadowSchema = z.object({
|
|
|
2165
2165
|
return v;
|
|
2166
2166
|
return Number(v);
|
|
2167
2167
|
} return v; }), z.number().gte(0).lte(1)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(0.5),
|
|
2168
|
-
});
|
|
2168
|
+
}).strict();
|
|
2169
2169
|
export const svgShadowSchema = svgpropertiesSvgShadowSchema;
|
|
2170
2170
|
/**
|
|
2171
2171
|
* A solid color fill for SVG shapes.
|
|
@@ -2183,7 +2183,7 @@ export const svgpropertiesSvgSolidFillSchema = z.object({
|
|
|
2183
2183
|
return v;
|
|
2184
2184
|
return Number(v);
|
|
2185
2185
|
} return v; }), z.number().gte(0).lte(1)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(1),
|
|
2186
|
-
});
|
|
2186
|
+
}).strict();
|
|
2187
2187
|
export const svgSolidFillSchema = svgpropertiesSvgSolidFillSchema;
|
|
2188
2188
|
/**
|
|
2189
2189
|
* Fill properties for SVG shapes. Supports solid colors and gradients.
|
|
@@ -2233,7 +2233,7 @@ export const svgpropertiesSvgStrokeSchema = z.object({
|
|
|
2233
2233
|
return v;
|
|
2234
2234
|
return Number(v);
|
|
2235
2235
|
} return v; }), z.number()), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(0),
|
|
2236
|
-
});
|
|
2236
|
+
}).strict();
|
|
2237
2237
|
export const svgStrokeSchema = svgpropertiesSvgStrokeSchema;
|
|
2238
2238
|
/**
|
|
2239
2239
|
* Transformation properties for positioning, rotating, and scaling SVG shapes.
|
|
@@ -2282,7 +2282,7 @@ export const svgpropertiesSvgTransformSchema = z.object({
|
|
|
2282
2282
|
return v;
|
|
2283
2283
|
return Number(v);
|
|
2284
2284
|
} return v; }), z.number().gte(0).lte(1)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(0.5),
|
|
2285
|
-
});
|
|
2285
|
+
}).strict();
|
|
2286
2286
|
export const svgTransformSchema = svgpropertiesSvgTransformSchema;
|
|
2287
2287
|
/**
|
|
2288
2288
|
* An arrow shape pointing to the right by default.
|
|
@@ -2319,7 +2319,7 @@ export const svgshapesSvgArrowShapeSchema = z.object({
|
|
|
2319
2319
|
return v;
|
|
2320
2320
|
return Number(v);
|
|
2321
2321
|
} return v; }), z.number().gte(1).lte(1000)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]),
|
|
2322
|
-
});
|
|
2322
|
+
}).strict();
|
|
2323
2323
|
export const svgArrowShapeSchema = svgshapesSvgArrowShapeSchema;
|
|
2324
2324
|
/**
|
|
2325
2325
|
* A perfect circle shape defined by its radius.
|
|
@@ -2335,7 +2335,7 @@ export const svgshapesSvgCircleShapeSchema = z.object({
|
|
|
2335
2335
|
return v;
|
|
2336
2336
|
return Number(v);
|
|
2337
2337
|
} return v; }), z.number().gte(1).lte(2048)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]),
|
|
2338
|
-
});
|
|
2338
|
+
}).strict();
|
|
2339
2339
|
export const svgCircleShapeSchema = svgshapesSvgCircleShapeSchema;
|
|
2340
2340
|
/**
|
|
2341
2341
|
* A cross or plus shape with equal or different arm lengths.
|
|
@@ -2365,7 +2365,7 @@ export const svgshapesSvgCrossShapeSchema = z.object({
|
|
|
2365
2365
|
return v;
|
|
2366
2366
|
return Number(v);
|
|
2367
2367
|
} return v; }), z.number().gte(1).lte(500)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]),
|
|
2368
|
-
});
|
|
2368
|
+
}).strict();
|
|
2369
2369
|
export const svgCrossShapeSchema = svgshapesSvgCrossShapeSchema;
|
|
2370
2370
|
/**
|
|
2371
2371
|
* An ellipse (oval) shape with separate horizontal and vertical radii.
|
|
@@ -2388,7 +2388,7 @@ export const svgshapesSvgEllipseShapeSchema = z.object({
|
|
|
2388
2388
|
return v;
|
|
2389
2389
|
return Number(v);
|
|
2390
2390
|
} return v; }), z.number().gte(1).lte(2048)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]),
|
|
2391
|
-
});
|
|
2391
|
+
}).strict();
|
|
2392
2392
|
export const svgEllipseShapeSchema = svgshapesSvgEllipseShapeSchema;
|
|
2393
2393
|
/**
|
|
2394
2394
|
* A heart shape commonly used for love/like icons.
|
|
@@ -2404,7 +2404,7 @@ export const svgshapesSvgHeartShapeSchema = z.object({
|
|
|
2404
2404
|
return v;
|
|
2405
2405
|
return Number(v);
|
|
2406
2406
|
} return v; }), z.number().gte(1).lte(4096)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]),
|
|
2407
|
-
});
|
|
2407
|
+
}).strict();
|
|
2408
2408
|
export const svgHeartShapeSchema = svgshapesSvgHeartShapeSchema;
|
|
2409
2409
|
/**
|
|
2410
2410
|
* A straight line shape with a specified length and thickness.
|
|
@@ -2427,7 +2427,7 @@ export const svgshapesSvgLineShapeSchema = z.object({
|
|
|
2427
2427
|
return v;
|
|
2428
2428
|
return Number(v);
|
|
2429
2429
|
} return v; }), z.number().gte(1).lte(500)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]),
|
|
2430
|
-
});
|
|
2430
|
+
}).strict();
|
|
2431
2431
|
export const svgLineShapeSchema = svgshapesSvgLineShapeSchema;
|
|
2432
2432
|
/**
|
|
2433
2433
|
* A custom shape defined by SVG path data.
|
|
@@ -2449,7 +2449,7 @@ export const svgLineShapeSchema = svgshapesSvgLineShapeSchema;
|
|
|
2449
2449
|
export const svgshapesSvgPathShapeSchema = z.object({
|
|
2450
2450
|
type: z.enum(["path"]),
|
|
2451
2451
|
d: z.string().min(1).max(100000),
|
|
2452
|
-
});
|
|
2452
|
+
}).strict();
|
|
2453
2453
|
export const svgPathShapeSchema = svgshapesSvgPathShapeSchema;
|
|
2454
2454
|
/**
|
|
2455
2455
|
* A regular polygon shape with a specified number of sides.
|
|
@@ -2473,7 +2473,7 @@ export const svgshapesSvgPolygonShapeSchema = z.object({
|
|
|
2473
2473
|
return v;
|
|
2474
2474
|
return Number(v);
|
|
2475
2475
|
} return v; }), z.number().gte(1).lte(2048)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]),
|
|
2476
|
-
});
|
|
2476
|
+
}).strict();
|
|
2477
2477
|
export const svgPolygonShapeSchema = svgshapesSvgPolygonShapeSchema;
|
|
2478
2478
|
/**
|
|
2479
2479
|
* A rectangle shape with optional rounded corners.
|
|
@@ -2503,7 +2503,7 @@ export const svgshapesSvgRectangleShapeSchema = z.object({
|
|
|
2503
2503
|
return v;
|
|
2504
2504
|
return Number(v);
|
|
2505
2505
|
} return v; }), z.number().gte(0).lte(2048)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])).default(0),
|
|
2506
|
-
});
|
|
2506
|
+
}).strict();
|
|
2507
2507
|
export const svgRectangleShapeSchema = svgshapesSvgRectangleShapeSchema;
|
|
2508
2508
|
/**
|
|
2509
2509
|
* A ring (donut/annulus) shape - a circle with a circular hole in the center.
|
|
@@ -2526,7 +2526,7 @@ export const svgshapesSvgRingShapeSchema = z.object({
|
|
|
2526
2526
|
return v;
|
|
2527
2527
|
return Number(v);
|
|
2528
2528
|
} return v; }), z.number().gte(0).lte(2048)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]),
|
|
2529
|
-
});
|
|
2529
|
+
}).strict();
|
|
2530
2530
|
export const svgRingShapeSchema = svgshapesSvgRingShapeSchema;
|
|
2531
2531
|
/**
|
|
2532
2532
|
* A star shape with a specified number of points.
|
|
@@ -2557,7 +2557,7 @@ export const svgshapesSvgStarShapeSchema = z.object({
|
|
|
2557
2557
|
return v;
|
|
2558
2558
|
return Number(v);
|
|
2559
2559
|
} return v; }), z.number().gte(1).lte(2048)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]),
|
|
2560
|
-
});
|
|
2560
|
+
}).strict();
|
|
2561
2561
|
export const svgStarShapeSchema = svgshapesSvgStarShapeSchema;
|
|
2562
2562
|
/**
|
|
2563
2563
|
* The shape definition for an SVG asset. Each shape type has its own specific
|
|
@@ -2651,7 +2651,7 @@ export const svgassetSvgAssetSchema = z.object({
|
|
|
2651
2651
|
return v;
|
|
2652
2652
|
return Number(v);
|
|
2653
2653
|
} return v; }), z.number().int().gte(1).lte(4096)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
|
|
2654
|
-
}).superRefine((data, ctx) => {
|
|
2654
|
+
}).strict().superRefine((data, ctx) => {
|
|
2655
2655
|
const hasShape = data.shape !== undefined;
|
|
2656
2656
|
const hasSrc = data.src !== undefined && data.src.trim() !== "";
|
|
2657
2657
|
if (!hasShape && !hasSrc) {
|
|
@@ -2688,7 +2688,7 @@ export const svgAssetSchema = svgassetSvgAssetSchema;
|
|
|
2688
2688
|
export const templaterenderTemplateRenderSchema = z.object({
|
|
2689
2689
|
id: z.string(),
|
|
2690
2690
|
merge: z.optional(z.array(mergefieldMergeFieldSchema)),
|
|
2691
|
-
});
|
|
2691
|
+
}).strict();
|
|
2692
2692
|
export const templateRenderSchema = templaterenderTemplateRenderSchema;
|
|
2693
2693
|
/**
|
|
2694
2694
|
* Horizontal and vertical alignment properties for text.
|
|
@@ -2696,7 +2696,7 @@ export const templateRenderSchema = templaterenderTemplateRenderSchema;
|
|
|
2696
2696
|
export const textpropertiesTextAlignmentSchema = z.object({
|
|
2697
2697
|
horizontal: z.optional(z.enum(["left", "center", "right"])),
|
|
2698
2698
|
vertical: z.optional(z.enum(["top", "center", "bottom"])),
|
|
2699
|
-
});
|
|
2699
|
+
}).strict();
|
|
2700
2700
|
export const textAlignmentSchema = textpropertiesTextAlignmentSchema;
|
|
2701
2701
|
/**
|
|
2702
2702
|
* Animation properties for text entrance effects.
|
|
@@ -2710,7 +2710,7 @@ export const textpropertiesTextAnimationSchema = z.object({
|
|
|
2710
2710
|
return v;
|
|
2711
2711
|
return Number(v);
|
|
2712
2712
|
} return v; }), z.number().gte(0.1).lte(30)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
|
|
2713
|
-
});
|
|
2713
|
+
}).strict();
|
|
2714
2714
|
/**
|
|
2715
2715
|
* Displays a background box behind the text.
|
|
2716
2716
|
*/
|
|
@@ -2737,7 +2737,7 @@ export const textpropertiesTextBackgroundSchema = z.object({
|
|
|
2737
2737
|
return v;
|
|
2738
2738
|
return Number(v);
|
|
2739
2739
|
} return v; }), z.number().gte(0)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
|
|
2740
|
-
});
|
|
2740
|
+
}).strict();
|
|
2741
2741
|
export const textBackgroundSchema = textpropertiesTextBackgroundSchema;
|
|
2742
2742
|
/**
|
|
2743
2743
|
* Font properties for text.
|
|
@@ -2773,7 +2773,7 @@ export const textpropertiesTextFontSchema = z.object({
|
|
|
2773
2773
|
return v;
|
|
2774
2774
|
return Number(v);
|
|
2775
2775
|
} return v; }), z.number()), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
|
|
2776
|
-
});
|
|
2776
|
+
}).strict();
|
|
2777
2777
|
export const textFontSchema = textpropertiesTextFontSchema;
|
|
2778
2778
|
/**
|
|
2779
2779
|
* Text stroke (outline) properties.
|
|
@@ -2787,7 +2787,7 @@ export const textpropertiesTextStrokeSchema = z.object({
|
|
|
2787
2787
|
return Number(v);
|
|
2788
2788
|
} return v; }), z.number().gte(0).lte(10)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
|
|
2789
2789
|
color: z.optional(z.union([z.string().regex(/^#[A-Fa-f0-9]{6}$/), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
|
|
2790
|
-
});
|
|
2790
|
+
}).strict();
|
|
2791
2791
|
/**
|
|
2792
2792
|
* The TextAsset is used to add text and titles to a video. The text can be styled with built in and custom
|
|
2793
2793
|
* [Fonts](#tocs_font). You can also add a background bounding box used to control wrapping and overflow. Emoticons are also supported.
|
|
@@ -2816,7 +2816,7 @@ export const textassetTextAssetSchema = z.object({
|
|
|
2816
2816
|
stroke: z.optional(textpropertiesTextStrokeSchema),
|
|
2817
2817
|
animation: z.optional(textpropertiesTextAnimationSchema),
|
|
2818
2818
|
ellipsis: z.optional(z.string()),
|
|
2819
|
-
});
|
|
2819
|
+
}).strict();
|
|
2820
2820
|
export const textAssetSchema = textassetTextAssetSchema;
|
|
2821
2821
|
/**
|
|
2822
2822
|
* The TextToImageAsset lets you create a dynamic image from a text prompt.
|
|
@@ -2839,7 +2839,7 @@ export const texttoimageassetTextToImageAssetSchema = z.object({
|
|
|
2839
2839
|
return Number(v);
|
|
2840
2840
|
} return v; }), z.number().int()), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
|
|
2841
2841
|
crop: z.optional(cropCropSchema),
|
|
2842
|
-
});
|
|
2842
|
+
}).strict();
|
|
2843
2843
|
export const textToImageAssetSchema = texttoimageassetTextToImageAssetSchema;
|
|
2844
2844
|
/**
|
|
2845
2845
|
* Generate a thumbnail image for the video or image at a specific point from the timeline.
|
|
@@ -2859,7 +2859,7 @@ export const thumbnailThumbnailSchema = z.object({
|
|
|
2859
2859
|
return v;
|
|
2860
2860
|
return Number(v);
|
|
2861
2861
|
} return v; }), z.number().gte(0).lte(1)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]),
|
|
2862
|
-
});
|
|
2862
|
+
}).strict();
|
|
2863
2863
|
export const thumbnailSchema = thumbnailThumbnailSchema;
|
|
2864
2864
|
/**
|
|
2865
2865
|
* The output format, render range and type of media to generate.
|
|
@@ -2890,7 +2890,7 @@ export const outputOutputSchema = z.object({
|
|
|
2890
2890
|
poster: z.optional(posterPosterSchema),
|
|
2891
2891
|
thumbnail: z.optional(thumbnailThumbnailSchema),
|
|
2892
2892
|
destinations: z.optional(z.array(destinationsDestinationsSchema)),
|
|
2893
|
-
});
|
|
2893
|
+
}).strict();
|
|
2894
2894
|
export const outputSchema = outputOutputSchema;
|
|
2895
2895
|
/**
|
|
2896
2896
|
* In and out transitions for a clip - i.e. fade in and fade out
|
|
@@ -3024,7 +3024,7 @@ export const transitionTransitionSchema = z.object({
|
|
|
3024
3024
|
"shuffleTopLeftFast",
|
|
3025
3025
|
"zoom",
|
|
3026
3026
|
])),
|
|
3027
|
-
});
|
|
3027
|
+
}).strict();
|
|
3028
3028
|
export const transitionSchema = transitionTransitionSchema;
|
|
3029
3029
|
/**
|
|
3030
3030
|
* Use a Tween to [animate properties over time](/docs/guide/architecting-an-application/animations/). The following properties are currently supported and can be animated:
|
|
@@ -3084,7 +3084,7 @@ export const tweenTweenSchema = z.object({
|
|
|
3084
3084
|
"easeInOutCirc",
|
|
3085
3085
|
"easeInOutBack",
|
|
3086
3086
|
])),
|
|
3087
|
-
});
|
|
3087
|
+
}).strict();
|
|
3088
3088
|
export const tweenSchema = tweenTweenSchema;
|
|
3089
3089
|
/**
|
|
3090
3090
|
* The AudioAsset is used to add sound effects and audio at specific intervals on the timeline. The src must be a publicly accessible URL to an audio resource such as an mp3 file.
|
|
@@ -3114,7 +3114,7 @@ export const audioassetAudioAssetSchema = z.object({
|
|
|
3114
3114
|
return Number(v);
|
|
3115
3115
|
} return v; }), z.number().gte(0).lte(10)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
|
|
3116
3116
|
effect: z.optional(z.enum(["none", "fadeIn", "fadeOut", "fadeInFadeOut"])),
|
|
3117
|
-
});
|
|
3117
|
+
}).strict();
|
|
3118
3118
|
export const audioAssetSchema = audioassetAudioAssetSchema;
|
|
3119
3119
|
/**
|
|
3120
3120
|
* Offsets the position of an asset horizontally or vertically by a relative distance.
|
|
@@ -3134,7 +3134,7 @@ export const offsetOffsetSchema = z.object({
|
|
|
3134
3134
|
return v;
|
|
3135
3135
|
return Number(v);
|
|
3136
3136
|
} return v; }), z.number().gte(-10).lte(10)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]), z.array(tweenTweenSchema)])),
|
|
3137
|
-
});
|
|
3137
|
+
}).strict();
|
|
3138
3138
|
export const offsetSchema = offsetOffsetSchema;
|
|
3139
3139
|
/**
|
|
3140
3140
|
* Rotate a clip by the specified angle in degrees. Rotation origin is set based on the clips `position`.
|
|
@@ -3147,7 +3147,7 @@ export const rotatetransformationRotateTransformationSchema = z.object({
|
|
|
3147
3147
|
return v;
|
|
3148
3148
|
return Number(v);
|
|
3149
3149
|
} return v; }), z.number().gte(-360).lte(360)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]), z.array(tweenTweenSchema)])),
|
|
3150
|
-
});
|
|
3150
|
+
}).strict();
|
|
3151
3151
|
export const rotateTransformationSchema = rotatetransformationRotateTransformationSchema;
|
|
3152
3152
|
/**
|
|
3153
3153
|
* 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.
|
|
@@ -3167,7 +3167,7 @@ export const skewtransformationSkewTransformationSchema = z.object({
|
|
|
3167
3167
|
return v;
|
|
3168
3168
|
return Number(v);
|
|
3169
3169
|
} return v; }), z.number().gte(-100).lte(100)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]), z.array(tweenTweenSchema)])),
|
|
3170
|
-
});
|
|
3170
|
+
}).strict();
|
|
3171
3171
|
export const skewTransformationSchema = skewtransformationSkewTransformationSchema;
|
|
3172
3172
|
/**
|
|
3173
3173
|
* The TextToSpeechAsset lets you generate a voice over from text using a text-to-speech service. The generated audio can be trimmed, faded and have its volume and speed adjusted using the same properties available on the AudioAsset.
|
|
@@ -3200,7 +3200,7 @@ export const texttospeechassetTextToSpeechAssetSchema = z.object({
|
|
|
3200
3200
|
return Number(v);
|
|
3201
3201
|
} return v; }), z.number().gte(0).lte(10)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
|
|
3202
3202
|
effect: z.optional(z.enum(["none", "fadeIn", "fadeOut", "fadeInFadeOut"])),
|
|
3203
|
-
});
|
|
3203
|
+
}).strict();
|
|
3204
3204
|
export const textToSpeechAssetSchema = texttospeechassetTextToSpeechAssetSchema;
|
|
3205
3205
|
/**
|
|
3206
3206
|
* **Notice: The TitleAsset is deprecated, use the [TextAsset](#tocs_textasset) instead.**
|
|
@@ -3248,7 +3248,7 @@ export const titleassetTitleAssetSchema = z.object({
|
|
|
3248
3248
|
"center",
|
|
3249
3249
|
])),
|
|
3250
3250
|
offset: z.optional(offsetOffsetSchema),
|
|
3251
|
-
});
|
|
3251
|
+
}).strict();
|
|
3252
3252
|
export const titleAssetSchema = titleassetTitleAssetSchema;
|
|
3253
3253
|
/**
|
|
3254
3254
|
* Apply one or more transformations to a clip. Transformations alter the visual properties of a clip and can be combined to create new shapes and effects.
|
|
@@ -3257,7 +3257,7 @@ export const transformationTransformationSchema = z.object({
|
|
|
3257
3257
|
rotate: z.optional(rotatetransformationRotateTransformationSchema),
|
|
3258
3258
|
skew: z.optional(skewtransformationSkewTransformationSchema),
|
|
3259
3259
|
flip: z.optional(fliptransformationFlipTransformationSchema),
|
|
3260
|
-
});
|
|
3260
|
+
}).strict();
|
|
3261
3261
|
export const transformationSchema = transformationTransformationSchema;
|
|
3262
3262
|
/**
|
|
3263
3263
|
* The VideoAsset is used to create video sequences from video files. The src must be a publicly accessible URL to a video resource such as an mp4 file.
|
|
@@ -3290,7 +3290,7 @@ export const videoassetVideoAssetSchema = z.object({
|
|
|
3290
3290
|
} return v; }), z.number().gte(0).lte(10)), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
|
|
3291
3291
|
crop: z.optional(cropCropSchema),
|
|
3292
3292
|
chromaKey: z.optional(chromakeyChromaKeySchema),
|
|
3293
|
-
});
|
|
3293
|
+
}).strict();
|
|
3294
3294
|
export const videoAssetSchema = videoassetVideoAssetSchema;
|
|
3295
3295
|
/**
|
|
3296
3296
|
* 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.
|
|
@@ -3413,7 +3413,7 @@ export const clipClipSchema = z.object({
|
|
|
3413
3413
|
} return v; }), z.number()), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)]), z.array(tweenTweenSchema)])),
|
|
3414
3414
|
transform: z.optional(transformationTransformationSchema),
|
|
3415
3415
|
alias: z.optional(z.union([z.string().regex(/^[A-Za-z0-9_-]+$/), z.string().regex(/^\{\{\s*[A-Za-z0-9_]+\s*\}\}$/)])),
|
|
3416
|
-
});
|
|
3416
|
+
}).strict();
|
|
3417
3417
|
export const clipSchema = clipClipSchema;
|
|
3418
3418
|
// Clip schema with fit property filter for rich-text assets
|
|
3419
3419
|
// This removes the 'fit' property when asset type is 'rich-text'
|
|
@@ -3432,7 +3432,7 @@ const clipClipSchemaWithFitFilter = clipClipSchema.transform((clip) => {
|
|
|
3432
3432
|
*/
|
|
3433
3433
|
export const trackTrackSchema = z.object({
|
|
3434
3434
|
clips: z.array(clipClipSchemaWithFitFilter).min(1),
|
|
3435
|
-
});
|
|
3435
|
+
}).strict();
|
|
3436
3436
|
export const trackSchema = trackTrackSchema;
|
|
3437
3437
|
/**
|
|
3438
3438
|
* A timeline represents the contents of a video edit over time, an audio edit over time, in seconds, or an image layout. A timeline consists of layers called tracks. Tracks are composed of titles, images, audio, html or video segments referred to as clips which are placed along the track at specific starting point and lasting for a specific amount of time.
|
|
@@ -3443,7 +3443,7 @@ export const timelineTimelineSchema = z.object({
|
|
|
3443
3443
|
fonts: z.optional(z.array(fontFontSchema)),
|
|
3444
3444
|
tracks: z.array(trackTrackSchema).min(1),
|
|
3445
3445
|
cache: z.optional(z.boolean()),
|
|
3446
|
-
});
|
|
3446
|
+
}).strict();
|
|
3447
3447
|
export const timelineSchema = timelineTimelineSchema;
|
|
3448
3448
|
/**
|
|
3449
3449
|
* An edit defines the arrangement of a video on a timeline, an audio edit or an image design and the output format. Video assets are automatically preprocessed to fix common compatibility issues before rendering. You can control preprocessing behavior using the `transcode` flag on video assets.
|
|
@@ -3454,7 +3454,7 @@ export const editEditSchema = z.object({
|
|
|
3454
3454
|
merge: z.optional(z.array(mergefieldMergeFieldSchema)),
|
|
3455
3455
|
callback: z.optional(z.string()),
|
|
3456
3456
|
disk: z.optional(z.enum(["local", "mount"])),
|
|
3457
|
-
});
|
|
3457
|
+
}).strict();
|
|
3458
3458
|
export const editSchema = editEditSchema;
|
|
3459
3459
|
/**
|
|
3460
3460
|
* The response data returned with the [RenderResponse](#tocs_renderresponse) including status and URL.
|
|
@@ -3493,7 +3493,7 @@ export const renderresponsedataRenderResponseDataSchema = z.object({
|
|
|
3493
3493
|
data: z.optional(editEditSchema),
|
|
3494
3494
|
created: z.optional(z.string()),
|
|
3495
3495
|
updated: z.optional(z.string()),
|
|
3496
|
-
});
|
|
3496
|
+
}).strict();
|
|
3497
3497
|
export const renderResponseDataSchema = renderresponsedataRenderResponseDataSchema;
|
|
3498
3498
|
/**
|
|
3499
3499
|
* The response received after a [render status request](#get-render-status) is submitted. The response includes details about status of a render and the output URL.
|
|
@@ -3502,7 +3502,7 @@ export const renderresponseRenderResponseSchema = z.object({
|
|
|
3502
3502
|
success: z.boolean(),
|
|
3503
3503
|
message: z.string(),
|
|
3504
3504
|
response: renderresponsedataRenderResponseDataSchema,
|
|
3505
|
-
});
|
|
3505
|
+
}).strict();
|
|
3506
3506
|
export const renderResponseSchema = renderresponseRenderResponseSchema;
|
|
3507
3507
|
/**
|
|
3508
3508
|
* The response data returned with the [TemplateDataResponse](#tocs_templatedataresponse).
|
|
@@ -3512,7 +3512,7 @@ export const templatedataresponsedataTemplateDataResponseDataSchema = z.object({
|
|
|
3512
3512
|
name: z.string(),
|
|
3513
3513
|
owner: z.string(),
|
|
3514
3514
|
template: editEditSchema,
|
|
3515
|
-
});
|
|
3515
|
+
}).strict();
|
|
3516
3516
|
export const templateDataResponseDataSchema = templatedataresponsedataTemplateDataResponseDataSchema;
|
|
3517
3517
|
/**
|
|
3518
3518
|
* The template data including the template name and [Edit](#tocs_edit).
|
|
@@ -3521,7 +3521,7 @@ export const templatedataresponseTemplateDataResponseSchema = z.object({
|
|
|
3521
3521
|
success: z.boolean(),
|
|
3522
3522
|
message: z.string(),
|
|
3523
3523
|
response: templatedataresponsedataTemplateDataResponseDataSchema,
|
|
3524
|
-
});
|
|
3524
|
+
}).strict();
|
|
3525
3525
|
export const templateDataResponseSchema = templatedataresponseTemplateDataResponseSchema;
|
|
3526
3526
|
/**
|
|
3527
3527
|
* A template is a saved [Edit](#tocs_edit) than can be loaded and re-used.
|
|
@@ -3529,13 +3529,13 @@ export const templateDataResponseSchema = templatedataresponseTemplateDataRespon
|
|
|
3529
3529
|
export const templateTemplateSchema = z.object({
|
|
3530
3530
|
name: z.string(),
|
|
3531
3531
|
template: z.optional(editEditSchema),
|
|
3532
|
-
});
|
|
3532
|
+
}).strict();
|
|
3533
3533
|
export const templateSchema = templateTemplateSchema;
|
|
3534
3534
|
export const postRenderRequest = z.object({
|
|
3535
3535
|
body: editEditSchema,
|
|
3536
3536
|
path: z.optional(z.never()),
|
|
3537
3537
|
query: z.optional(z.never()),
|
|
3538
|
-
});
|
|
3538
|
+
}).strict();
|
|
3539
3539
|
/**
|
|
3540
3540
|
* The queued render details
|
|
3541
3541
|
*/
|
|
@@ -3551,7 +3551,7 @@ export const getRenderRequest = z.object({
|
|
|
3551
3551
|
data: z.optional(z.boolean()),
|
|
3552
3552
|
merged: z.optional(z.boolean()),
|
|
3553
3553
|
})),
|
|
3554
|
-
});
|
|
3554
|
+
}).strict();
|
|
3555
3555
|
/**
|
|
3556
3556
|
* The render status details
|
|
3557
3557
|
*/
|
|
@@ -3560,7 +3560,7 @@ export const getTemplatesRequest = z.object({
|
|
|
3560
3560
|
body: z.optional(z.never()),
|
|
3561
3561
|
path: z.optional(z.never()),
|
|
3562
3562
|
query: z.optional(z.never()),
|
|
3563
|
-
});
|
|
3563
|
+
}).strict();
|
|
3564
3564
|
/**
|
|
3565
3565
|
* The list of templates stored against a users account
|
|
3566
3566
|
*/
|
|
@@ -3569,7 +3569,7 @@ export const postTemplateRequest = z.object({
|
|
|
3569
3569
|
body: templateTemplateSchema,
|
|
3570
3570
|
path: z.optional(z.never()),
|
|
3571
3571
|
query: z.optional(z.never()),
|
|
3572
|
-
});
|
|
3572
|
+
}).strict();
|
|
3573
3573
|
/**
|
|
3574
3574
|
* The saved template status including the id
|
|
3575
3575
|
*/
|
|
@@ -3582,7 +3582,7 @@ export const deleteTemplateRequest = z.object({
|
|
|
3582
3582
|
.regex(/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/),
|
|
3583
3583
|
}),
|
|
3584
3584
|
query: z.optional(z.never()),
|
|
3585
|
-
});
|
|
3585
|
+
}).strict();
|
|
3586
3586
|
/**
|
|
3587
3587
|
* An empty response signifying the template has been deleted
|
|
3588
3588
|
*/
|
|
@@ -3595,7 +3595,7 @@ export const getTemplateRequest = z.object({
|
|
|
3595
3595
|
.regex(/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/),
|
|
3596
3596
|
}),
|
|
3597
3597
|
query: z.optional(z.never()),
|
|
3598
|
-
});
|
|
3598
|
+
}).strict();
|
|
3599
3599
|
/**
|
|
3600
3600
|
* The template details including the [Edit](#tocs_edit)
|
|
3601
3601
|
*/
|
|
@@ -3608,7 +3608,7 @@ export const putTemplateRequest = z.object({
|
|
|
3608
3608
|
.regex(/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/),
|
|
3609
3609
|
}),
|
|
3610
3610
|
query: z.optional(z.never()),
|
|
3611
|
-
});
|
|
3611
|
+
}).strict();
|
|
3612
3612
|
/**
|
|
3613
3613
|
* Update a templates name and [Edit](#tocs_edit)
|
|
3614
3614
|
*/
|
|
@@ -3617,7 +3617,7 @@ export const postTemplateRenderRequest = z.object({
|
|
|
3617
3617
|
body: templaterenderTemplateRenderSchema,
|
|
3618
3618
|
path: z.optional(z.never()),
|
|
3619
3619
|
query: z.optional(z.never()),
|
|
3620
|
-
});
|
|
3620
|
+
}).strict();
|
|
3621
3621
|
/**
|
|
3622
3622
|
* The queued status including the render id. Check the status of the render using the id and the [render status](#get-render-status) endpoint.
|
|
3623
3623
|
*/
|
|
@@ -3628,7 +3628,7 @@ export const probeRequest = z.object({
|
|
|
3628
3628
|
url: z.string(),
|
|
3629
3629
|
}),
|
|
3630
3630
|
query: z.optional(z.never()),
|
|
3631
|
-
});
|
|
3631
|
+
}).strict();
|
|
3632
3632
|
/**
|
|
3633
3633
|
* FFprobe response formatted as JSON.
|
|
3634
3634
|
*/
|
|
@@ -3641,7 +3641,7 @@ export const deleteAssetRequest = z.object({
|
|
|
3641
3641
|
.regex(/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/),
|
|
3642
3642
|
}),
|
|
3643
3643
|
query: z.optional(z.never()),
|
|
3644
|
-
});
|
|
3644
|
+
}).strict();
|
|
3645
3645
|
/**
|
|
3646
3646
|
* An empty response signifying the asset has been deleted
|
|
3647
3647
|
*/
|
|
@@ -3654,7 +3654,7 @@ export const getAssetRequest = z.object({
|
|
|
3654
3654
|
.regex(/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/),
|
|
3655
3655
|
}),
|
|
3656
3656
|
query: z.optional(z.never()),
|
|
3657
|
-
});
|
|
3657
|
+
}).strict();
|
|
3658
3658
|
/**
|
|
3659
3659
|
* Get asset by asset id
|
|
3660
3660
|
*/
|
|
@@ -3667,7 +3667,7 @@ export const getAssetByRenderIdRequest = z.object({
|
|
|
3667
3667
|
.regex(/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/),
|
|
3668
3668
|
}),
|
|
3669
3669
|
query: z.optional(z.never()),
|
|
3670
|
-
});
|
|
3670
|
+
}).strict();
|
|
3671
3671
|
/**
|
|
3672
3672
|
* Get one or more assets by render id
|
|
3673
3673
|
*/
|
|
@@ -3676,7 +3676,7 @@ export const postServeAssetRequest = z.object({
|
|
|
3676
3676
|
body: transferTransferSchema,
|
|
3677
3677
|
path: z.optional(z.never()),
|
|
3678
3678
|
query: z.optional(z.never()),
|
|
3679
|
-
});
|
|
3679
|
+
}).strict();
|
|
3680
3680
|
/**
|
|
3681
3681
|
* The transfer request details and status
|
|
3682
3682
|
*/
|
|
@@ -3685,7 +3685,7 @@ export const getSourcesRequest = z.object({
|
|
|
3685
3685
|
body: z.optional(z.never()),
|
|
3686
3686
|
path: z.optional(z.never()),
|
|
3687
3687
|
query: z.optional(z.never()),
|
|
3688
|
-
});
|
|
3688
|
+
}).strict();
|
|
3689
3689
|
/**
|
|
3690
3690
|
* The list of ingested source files stored against a users account
|
|
3691
3691
|
*/
|
|
@@ -3694,7 +3694,7 @@ export const postSourceRequest = z.object({
|
|
|
3694
3694
|
body: sourceSourceSchema,
|
|
3695
3695
|
path: z.optional(z.never()),
|
|
3696
3696
|
query: z.optional(z.never()),
|
|
3697
|
-
});
|
|
3697
|
+
}).strict();
|
|
3698
3698
|
/**
|
|
3699
3699
|
* The queued source file details
|
|
3700
3700
|
*/
|
|
@@ -3707,7 +3707,7 @@ export const deleteSourceRequest = z.object({
|
|
|
3707
3707
|
.regex(/^[0-9a-zA-Z]{8}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{12}$/),
|
|
3708
3708
|
}),
|
|
3709
3709
|
query: z.optional(z.never()),
|
|
3710
|
-
});
|
|
3710
|
+
}).strict();
|
|
3711
3711
|
/**
|
|
3712
3712
|
* An empty response signifying the ingested source file has been deleted.
|
|
3713
3713
|
*/
|
|
@@ -3720,7 +3720,7 @@ export const getSourceRequest = z.object({
|
|
|
3720
3720
|
.regex(/^[0-9a-zA-Z]{8}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{12}$/),
|
|
3721
3721
|
}),
|
|
3722
3722
|
query: z.optional(z.never()),
|
|
3723
|
-
});
|
|
3723
|
+
}).strict();
|
|
3724
3724
|
/**
|
|
3725
3725
|
* Get source file details by id
|
|
3726
3726
|
*/
|
|
@@ -3729,7 +3729,7 @@ export const getUploadSignedUrlRequest = z.object({
|
|
|
3729
3729
|
body: z.optional(z.never()),
|
|
3730
3730
|
path: z.optional(z.never()),
|
|
3731
3731
|
query: z.optional(z.never()),
|
|
3732
|
-
});
|
|
3732
|
+
}).strict();
|
|
3733
3733
|
/**
|
|
3734
3734
|
* The id and signed URL to upload to.
|
|
3735
3735
|
*/
|
|
@@ -3738,7 +3738,7 @@ export const postGenerateAssetRequest = z.object({
|
|
|
3738
3738
|
body: generatedAssetGeneratedAssetSchema,
|
|
3739
3739
|
path: z.optional(z.never()),
|
|
3740
3740
|
query: z.optional(z.never()),
|
|
3741
|
-
});
|
|
3741
|
+
}).strict();
|
|
3742
3742
|
/**
|
|
3743
3743
|
* The generated asset details
|
|
3744
3744
|
*/
|
|
@@ -3751,7 +3751,7 @@ export const getGeneratedAssetRequest = z.object({
|
|
|
3751
3751
|
.regex(/^[0-9a-zA-Z]{8}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{12}$/),
|
|
3752
3752
|
}),
|
|
3753
3753
|
query: z.optional(z.never()),
|
|
3754
|
-
});
|
|
3754
|
+
}).strict();
|
|
3755
3755
|
/**
|
|
3756
3756
|
* The generated asset details
|
|
3757
3757
|
*/
|