-
Notifications
You must be signed in to change notification settings - Fork 47
Expand file tree
/
Copy pathwebhooks.ts
More file actions
1072 lines (905 loc) · 28 KB
/
webhooks.ts
File metadata and controls
1072 lines (905 loc) · 28 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from '../core/resource';
import { toBase64 } from '../internal/utils';
import * as FilesAPI from './files/files';
import { Webhook } from 'standardwebhooks';
export class Webhooks extends APIResource {
unsafeUnwrap(body: string): UnsafeUnwrapWebhookEvent {
return JSON.parse(body) as UnsafeUnwrapWebhookEvent;
}
unwrap(
body: string,
{ headers, key }: { headers: Record<string, string>; key?: string },
): UnwrapWebhookEvent {
if (headers !== undefined) {
const keyStr: string | null = key === undefined ? this._client.webhookSecret : key;
if (keyStr === null) throw new Error('Webhook key must not be null in order to unwrap');
const wh = new Webhook(toBase64(keyStr));
wh.verify(body, headers);
}
return JSON.parse(body) as UnwrapWebhookEvent;
}
}
export interface BaseWebhookEvent {
/**
* Unique identifier for the event.
*/
id: string;
/**
* The type of webhook event.
*/
type: string;
}
/**
* Triggered when a post-transformation fails. The original file remains available,
* but the requested transformation could not be generated.
*/
export interface UploadPostTransformErrorEvent extends BaseWebhookEvent {
/**
* Timestamp of when the event occurred in ISO8601 format.
*/
created_at: string;
data: UploadPostTransformErrorEvent.Data;
request: UploadPostTransformErrorEvent.Request;
type: 'upload.post-transform.error';
}
export namespace UploadPostTransformErrorEvent {
export interface Data {
/**
* Unique identifier of the originally uploaded file.
*/
fileId: string;
/**
* Name of the file.
*/
name: string;
/**
* Path of the file.
*/
path: string;
transformation: Data.Transformation;
/**
* URL of the attempted post-transformation.
*/
url: string;
}
export namespace Data {
export interface Transformation {
error: Transformation.Error;
}
export namespace Transformation {
export interface Error {
/**
* Reason for the post-transformation failure.
*/
reason: string;
}
}
}
export interface Request {
transformation: Request.Transformation;
/**
* Unique identifier for the originating request.
*/
x_request_id: string;
}
export namespace Request {
export interface Transformation {
/**
* Type of the requested post-transformation.
*/
type: 'transformation' | 'abs' | 'gif-to-video' | 'thumbnail';
/**
* Only applicable if transformation type is 'abs'. Streaming protocol used.
*/
protocol?: 'hls' | 'dash';
/**
* Value for the requested transformation type.
*/
value?: string;
}
}
}
/**
* Triggered when a post-transformation completes successfully. The transformed
* version of the file is now ready and can be accessed via the provided URL. Note
* that each post-transformation generates a separate webhook event.
*/
export interface UploadPostTransformSuccessEvent extends BaseWebhookEvent {
/**
* Timestamp of when the event occurred in ISO8601 format.
*/
created_at: string;
data: UploadPostTransformSuccessEvent.Data;
request: UploadPostTransformSuccessEvent.Request;
type: 'upload.post-transform.success';
}
export namespace UploadPostTransformSuccessEvent {
export interface Data {
/**
* Unique identifier of the originally uploaded file.
*/
fileId: string;
/**
* Name of the file.
*/
name: string;
/**
* URL of the generated post-transformation.
*/
url: string;
}
export interface Request {
transformation: Request.Transformation;
/**
* Unique identifier for the originating request.
*/
x_request_id: string;
}
export namespace Request {
export interface Transformation {
/**
* Type of the requested post-transformation.
*/
type: 'transformation' | 'abs' | 'gif-to-video' | 'thumbnail';
/**
* Only applicable if transformation type is 'abs'. Streaming protocol used.
*/
protocol?: 'hls' | 'dash';
/**
* Value for the requested transformation type.
*/
value?: string;
}
}
}
/**
* Triggered when a pre-transformation fails. The file upload may have been
* accepted, but the requested transformation could not be applied.
*/
export interface UploadPreTransformErrorEvent extends BaseWebhookEvent {
/**
* Timestamp of when the event occurred in ISO8601 format.
*/
created_at: string;
data: UploadPreTransformErrorEvent.Data;
request: UploadPreTransformErrorEvent.Request;
type: 'upload.pre-transform.error';
}
export namespace UploadPreTransformErrorEvent {
export interface Data {
/**
* Name of the file.
*/
name: string;
/**
* Path of the file.
*/
path: string;
transformation: Data.Transformation;
}
export namespace Data {
export interface Transformation {
error: Transformation.Error;
}
export namespace Transformation {
export interface Error {
/**
* Reason for the pre-transformation failure.
*/
reason: string;
}
}
}
export interface Request {
/**
* The requested pre-transformation string.
*/
transformation: string;
/**
* Unique identifier for the originating request.
*/
x_request_id: string;
}
}
/**
* Triggered when a pre-transformation completes successfully. The file has been
* processed with the requested transformation and is now available in the Media
* Library.
*/
export interface UploadPreTransformSuccessEvent extends BaseWebhookEvent {
/**
* Timestamp of when the event occurred in ISO8601 format.
*/
created_at: string;
/**
* Object containing details of a successful upload.
*/
data: UploadPreTransformSuccessEvent.Data;
request: UploadPreTransformSuccessEvent.Request;
type: 'upload.pre-transform.success';
}
export namespace UploadPreTransformSuccessEvent {
/**
* Object containing details of a successful upload.
*/
export interface Data {
/**
* An array of tags assigned to the uploaded file by auto tagging.
*/
AITags?: Array<Data.AITag> | null;
/**
* The audio codec used in the video (only for video).
*/
audioCodec?: string;
/**
* The bit rate of the video in kbps (only for video).
*/
bitRate?: number;
/**
* Value of custom coordinates associated with the image in the format
* `x,y,width,height`. If `customCoordinates` are not defined, then it is `null`.
* Send `customCoordinates` in `responseFields` in API request to get the value of
* this field.
*/
customCoordinates?: string | null;
/**
* A key-value data associated with the asset. Use `responseField` in API request
* to get `customMetadata` in the upload API response. Before setting any custom
* metadata on an asset, you have to create the field using custom metadata fields
* API. Send `customMetadata` in `responseFields` in API request to get the value
* of this field.
*/
customMetadata?: { [key: string]: unknown };
/**
* Optional text to describe the contents of the file. Can be set by the user or
* the ai-auto-description extension.
*/
description?: string;
/**
* The duration of the video in seconds (only for video).
*/
duration?: number;
/**
* Consolidated embedded metadata associated with the file. It includes exif, iptc,
* and xmp data. Send `embeddedMetadata` in `responseFields` in API request to get
* embeddedMetadata in the upload API response.
*/
embeddedMetadata?: { [key: string]: unknown };
/**
* Extension names with their processing status at the time of completion of the
* request. It could have one of the following status values:
*
* `success`: The extension has been successfully applied. `failed`: The extension
* has failed and will not be retried. `pending`: The extension will finish
* processing in some time. On completion, the final status (success / failed) will
* be sent to the `webhookUrl` provided.
*
* If no extension was requested, then this parameter is not returned.
*/
extensionStatus?: Data.ExtensionStatus;
/**
* Unique fileId. Store this fileld in your database, as this will be used to
* perform update action on this file.
*/
fileId?: string;
/**
* The relative path of the file in the media library e.g.
* `/marketing-assets/new-banner.jpg`.
*/
filePath?: string;
/**
* Type of the uploaded file. Possible values are `image`, `non-image`.
*/
fileType?: string;
/**
* Height of the image in pixels (Only for images)
*/
height?: number;
/**
* Is the file marked as private. It can be either `true` or `false`. Send
* `isPrivateFile` in `responseFields` in API request to get the value of this
* field.
*/
isPrivateFile?: boolean;
/**
* Is the file published or in draft state. It can be either `true` or `false`.
* Send `isPublished` in `responseFields` in API request to get the value of this
* field.
*/
isPublished?: boolean;
/**
* Legacy metadata. Send `metadata` in `responseFields` in API request to get
* metadata in the upload API response.
*/
metadata?: FilesAPI.Metadata;
/**
* Name of the asset.
*/
name?: string;
/**
* This field is included in the response only if the Path policy feature is
* available in the plan. It contains schema definitions for the custom metadata
* fields selected for the specified file path. Field selection can only be done
* when the Path policy feature is enabled.
*
* Keys are the names of the custom metadata fields; the value object has details
* about the custom metadata schema.
*/
selectedFieldsSchema?: { [key: string]: Data.SelectedFieldsSchema };
/**
* Size of the image file in Bytes.
*/
size?: number;
/**
* The array of tags associated with the asset. If no tags are set, it will be
* `null`. Send `tags` in `responseFields` in API request to get the value of this
* field.
*/
tags?: Array<string> | null;
/**
* In the case of an image, a small thumbnail URL.
*/
thumbnailUrl?: string;
/**
* A publicly accessible URL of the file.
*/
url?: string;
/**
* An object containing the file or file version's `id` (versionId) and `name`.
*/
versionInfo?: Data.VersionInfo;
/**
* The video codec used in the video (only for video).
*/
videoCodec?: string;
/**
* Width of the image in pixels (Only for Images)
*/
width?: number;
}
export namespace Data {
export interface AITag {
/**
* Confidence score of the tag.
*/
confidence?: number;
/**
* Name of the tag.
*/
name?: string;
/**
* Array of `AITags` associated with the image. If no `AITags` are set, it will be
* null. These tags can be added using the `google-auto-tagging` or
* `aws-auto-tagging` extensions.
*/
source?: string;
}
/**
* Extension names with their processing status at the time of completion of the
* request. It could have one of the following status values:
*
* `success`: The extension has been successfully applied. `failed`: The extension
* has failed and will not be retried. `pending`: The extension will finish
* processing in some time. On completion, the final status (success / failed) will
* be sent to the `webhookUrl` provided.
*
* If no extension was requested, then this parameter is not returned.
*/
export interface ExtensionStatus {
'ai-auto-description'?: 'success' | 'pending' | 'failed';
'ai-tasks'?: 'success' | 'pending' | 'failed';
'aws-auto-tagging'?: 'success' | 'pending' | 'failed';
'google-auto-tagging'?: 'success' | 'pending' | 'failed';
'remove-bg'?: 'success' | 'pending' | 'failed';
}
export interface SelectedFieldsSchema {
/**
* Type of the custom metadata field.
*/
type: 'Text' | 'Textarea' | 'Number' | 'Date' | 'Boolean' | 'SingleSelect' | 'MultiSelect';
/**
* The default value for this custom metadata field. The value should match the
* `type` of custom metadata field.
*/
defaultValue?: string | number | boolean | Array<string | number | boolean>;
/**
* Specifies if the custom metadata field is required or not.
*/
isValueRequired?: boolean;
/**
* Maximum length of string. Only set if `type` is set to `Text` or `Textarea`.
*/
maxLength?: number;
/**
* Maximum value of the field. Only set if field type is `Date` or `Number`. For
* `Date` type field, the value will be in ISO8601 string format. For `Number` type
* field, it will be a numeric value.
*/
maxValue?: string | number;
/**
* Minimum length of string. Only set if `type` is set to `Text` or `Textarea`.
*/
minLength?: number;
/**
* Minimum value of the field. Only set if field type is `Date` or `Number`. For
* `Date` type field, the value will be in ISO8601 string format. For `Number` type
* field, it will be a numeric value.
*/
minValue?: string | number;
/**
* Indicates whether the custom metadata field is read only. A read only field
* cannot be modified after being set. This field is configurable only via the
* **Path policy** feature.
*/
readOnly?: boolean;
/**
* An array of allowed values when field type is `SingleSelect` or `MultiSelect`.
*/
selectOptions?: Array<string | number | boolean>;
/**
* Specifies if the selectOptions array is truncated. It is truncated when number
* of options are > 100.
*/
selectOptionsTruncated?: boolean;
}
/**
* An object containing the file or file version's `id` (versionId) and `name`.
*/
export interface VersionInfo {
/**
* Unique identifier of the file version.
*/
id?: string;
/**
* Name of the file version.
*/
name?: string;
}
}
export interface Request {
/**
* The requested pre-transformation string.
*/
transformation: string;
/**
* Unique identifier for the originating request.
*/
x_request_id: string;
}
}
/**
* Triggered when a new video transformation request is accepted for processing.
* This event confirms that ImageKit has received and queued your transformation
* request. Use this for debugging and tracking transformation lifecycle.
*/
export interface VideoTransformationAcceptedEvent extends BaseWebhookEvent {
/**
* Timestamp when the event was created in ISO8601 format.
*/
created_at: string;
data: VideoTransformationAcceptedEvent.Data;
/**
* Information about the original request that triggered the video transformation.
*/
request: VideoTransformationAcceptedEvent.Request;
type: 'video.transformation.accepted';
}
export namespace VideoTransformationAcceptedEvent {
export interface Data {
/**
* Information about the source video asset being transformed.
*/
asset: Data.Asset;
/**
* Base information about a video transformation request.
*/
transformation: Data.Transformation;
}
export namespace Data {
/**
* Information about the source video asset being transformed.
*/
export interface Asset {
/**
* URL to download or access the source video file.
*/
url: string;
}
/**
* Base information about a video transformation request.
*/
export interface Transformation {
/**
* Type of video transformation:
*
* - `video-transformation`: Standard video processing (resize, format conversion,
* etc.)
* - `gif-to-video`: Convert animated GIF to video format
* - `video-thumbnail`: Generate thumbnail image from video
*/
type: 'video-transformation' | 'gif-to-video' | 'video-thumbnail';
/**
* Configuration options for video transformations.
*/
options?: Transformation.Options;
}
export namespace Transformation {
/**
* Configuration options for video transformations.
*/
export interface Options {
/**
* Audio codec used for encoding (aac or opus).
*/
audio_codec?: 'aac' | 'opus';
/**
* Whether to automatically rotate the video based on metadata.
*/
auto_rotate?: boolean;
/**
* Output format for the transformed video or thumbnail.
*/
format?: 'mp4' | 'webm' | 'jpg' | 'png' | 'webp';
/**
* Quality setting for the output video.
*/
quality?: number;
/**
* Streaming protocol for adaptive bitrate streaming.
*/
stream_protocol?: 'HLS' | 'DASH';
/**
* Array of quality representations for adaptive bitrate streaming.
*/
variants?: Array<string>;
/**
* Video codec used for encoding (h264, vp9, or av1).
*/
video_codec?: 'h264' | 'vp9' | 'av1';
}
}
}
/**
* Information about the original request that triggered the video transformation.
*/
export interface Request {
/**
* Full URL of the transformation request that was submitted.
*/
url: string;
/**
* Unique identifier for the originating transformation request.
*/
x_request_id: string;
/**
* User-Agent header from the original request that triggered the transformation.
*/
user_agent?: string;
}
}
/**
* Triggered when an error occurs during video encoding. Listen to this webhook to
* log error reasons and debug issues. Check your origin and URL endpoint settings
* if the reason is related to download failure. For other errors, contact ImageKit
* support.
*/
export interface VideoTransformationErrorEvent extends BaseWebhookEvent {
/**
* Timestamp when the event was created in ISO8601 format.
*/
created_at: string;
data: VideoTransformationErrorEvent.Data;
/**
* Information about the original request that triggered the video transformation.
*/
request: VideoTransformationErrorEvent.Request;
type: 'video.transformation.error';
}
export namespace VideoTransformationErrorEvent {
export interface Data {
/**
* Information about the source video asset being transformed.
*/
asset: Data.Asset;
transformation: Data.Transformation;
}
export namespace Data {
/**
* Information about the source video asset being transformed.
*/
export interface Asset {
/**
* URL to download or access the source video file.
*/
url: string;
}
export interface Transformation {
/**
* Type of video transformation:
*
* - `video-transformation`: Standard video processing (resize, format conversion,
* etc.)
* - `gif-to-video`: Convert animated GIF to video format
* - `video-thumbnail`: Generate thumbnail image from video
*/
type: 'video-transformation' | 'gif-to-video' | 'video-thumbnail';
/**
* Details about the transformation error.
*/
error?: Transformation.Error;
/**
* Configuration options for video transformations.
*/
options?: Transformation.Options;
}
export namespace Transformation {
/**
* Details about the transformation error.
*/
export interface Error {
/**
* Specific reason for the transformation failure:
*
* - `encoding_failed`: Error during video encoding process
* - `download_failed`: Could not download source video
* - `internal_server_error`: Unexpected server error
*/
reason: 'encoding_failed' | 'download_failed' | 'internal_server_error';
}
/**
* Configuration options for video transformations.
*/
export interface Options {
/**
* Audio codec used for encoding (aac or opus).
*/
audio_codec?: 'aac' | 'opus';
/**
* Whether to automatically rotate the video based on metadata.
*/
auto_rotate?: boolean;
/**
* Output format for the transformed video or thumbnail.
*/
format?: 'mp4' | 'webm' | 'jpg' | 'png' | 'webp';
/**
* Quality setting for the output video.
*/
quality?: number;
/**
* Streaming protocol for adaptive bitrate streaming.
*/
stream_protocol?: 'HLS' | 'DASH';
/**
* Array of quality representations for adaptive bitrate streaming.
*/
variants?: Array<string>;
/**
* Video codec used for encoding (h264, vp9, or av1).
*/
video_codec?: 'h264' | 'vp9' | 'av1';
}
}
}
/**
* Information about the original request that triggered the video transformation.
*/
export interface Request {
/**
* Full URL of the transformation request that was submitted.
*/
url: string;
/**
* Unique identifier for the originating transformation request.
*/
x_request_id: string;
/**
* User-Agent header from the original request that triggered the transformation.
*/
user_agent?: string;
}
}
/**
* Triggered when video encoding is finished and the transformed resource is ready
* to be served. This is the key event to listen for - update your database or CMS
* flags when you receive this so your application can start showing the
* transformed video to users.
*/
export interface VideoTransformationReadyEvent extends BaseWebhookEvent {
/**
* Timestamp when the event was created in ISO8601 format.
*/
created_at: string;
data: VideoTransformationReadyEvent.Data;
/**
* Information about the original request that triggered the video transformation.
*/
request: VideoTransformationReadyEvent.Request;
type: 'video.transformation.ready';
/**
* Performance metrics for the transformation process.
*/
timings?: VideoTransformationReadyEvent.Timings;
}
export namespace VideoTransformationReadyEvent {
export interface Data {
/**
* Information about the source video asset being transformed.
*/
asset: Data.Asset;
transformation: Data.Transformation;
}
export namespace Data {
/**
* Information about the source video asset being transformed.
*/
export interface Asset {
/**
* URL to download or access the source video file.
*/
url: string;
}
export interface Transformation {
/**
* Type of video transformation:
*
* - `video-transformation`: Standard video processing (resize, format conversion,
* etc.)
* - `gif-to-video`: Convert animated GIF to video format
* - `video-thumbnail`: Generate thumbnail image from video
*/
type: 'video-transformation' | 'gif-to-video' | 'video-thumbnail';
/**
* Configuration options for video transformations.
*/
options?: Transformation.Options;
/**
* Information about the transformed output video.
*/
output?: Transformation.Output;
}
export namespace Transformation {
/**
* Configuration options for video transformations.
*/
export interface Options {
/**
* Audio codec used for encoding (aac or opus).
*/
audio_codec?: 'aac' | 'opus';
/**
* Whether to automatically rotate the video based on metadata.
*/
auto_rotate?: boolean;
/**
* Output format for the transformed video or thumbnail.
*/
format?: 'mp4' | 'webm' | 'jpg' | 'png' | 'webp';
/**
* Quality setting for the output video.
*/
quality?: number;
/**
* Streaming protocol for adaptive bitrate streaming.
*/
stream_protocol?: 'HLS' | 'DASH';
/**
* Array of quality representations for adaptive bitrate streaming.
*/
variants?: Array<string>;
/**
* Video codec used for encoding (h264, vp9, or av1).
*/
video_codec?: 'h264' | 'vp9' | 'av1';
}
/**
* Information about the transformed output video.
*/
export interface Output {
/**
* URL to access the transformed video.
*/
url: string;
/**
* Metadata of the output video file.
*/
video_metadata?: Output.VideoMetadata;
}
export namespace Output {
/**
* Metadata of the output video file.
*/
export interface VideoMetadata {
/**
* Bitrate of the output video in bits per second.
*/
bitrate: number;
/**
* Duration of the output video in seconds.
*/
duration: number;
/**
* Height of the output video in pixels.
*/
height: number;
/**
* Width of the output video in pixels.
*/
width: number;
}
}
}
}
/**
* Information about the original request that triggered the video transformation.
*/
export interface Request {
/**
* Full URL of the transformation request that was submitted.
*/