@blitzreels/sdk 0.1.2 → 0.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -0
- package/dist/index.d.ts +603 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +525 -1
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -170,6 +170,7 @@ export type MediaAttachResult = {
|
|
|
170
170
|
timeline_item_id: string | null;
|
|
171
171
|
message: string | null;
|
|
172
172
|
animation_applied: string | null;
|
|
173
|
+
layer_index: number | null;
|
|
173
174
|
}>;
|
|
174
175
|
summary: {
|
|
175
176
|
total: number;
|
|
@@ -179,6 +180,89 @@ export type MediaAttachResult = {
|
|
|
179
180
|
};
|
|
180
181
|
message: string;
|
|
181
182
|
};
|
|
183
|
+
export type MediaShortSuggestionList = {
|
|
184
|
+
saved: JsonObject[];
|
|
185
|
+
drafts: JsonObject[];
|
|
186
|
+
};
|
|
187
|
+
export type GenerateMediaShortSuggestionsOptions = {
|
|
188
|
+
assetId: string;
|
|
189
|
+
contentProfile: "auto" | "podcast" | "tutorial" | "generic" | undefined;
|
|
190
|
+
autoTrimSilence: boolean | undefined;
|
|
191
|
+
};
|
|
192
|
+
export type ApplyMediaShortSuggestionOptions = {
|
|
193
|
+
assetId: string;
|
|
194
|
+
suggestionId: string;
|
|
195
|
+
projectId: string;
|
|
196
|
+
captionStyleId: string | null | undefined;
|
|
197
|
+
markSaved: boolean | undefined;
|
|
198
|
+
allowUnverifiedExport: boolean | undefined;
|
|
199
|
+
automaticLayout: JsonObject | undefined;
|
|
200
|
+
};
|
|
201
|
+
export type ApplyMediaShortSuggestionResult = {
|
|
202
|
+
success: boolean;
|
|
203
|
+
project_id: string;
|
|
204
|
+
asset_id: string;
|
|
205
|
+
suggestion_id: string;
|
|
206
|
+
timeline_item_id: string;
|
|
207
|
+
[key: string]: unknown;
|
|
208
|
+
};
|
|
209
|
+
export type ClipSelectionMode = "auto_best" | "suggestion" | "time_range";
|
|
210
|
+
export type ClipLayoutMode = "auto" | "prefer_split" | "prefer_focus";
|
|
211
|
+
export type ClipContentTypeHint = "auto" | "podcast" | "tutorial" | "generic";
|
|
212
|
+
export type ClipQaMode = "required" | "permissive";
|
|
213
|
+
export type ClipTargetOptions = {
|
|
214
|
+
minDurationSeconds: number | null | undefined;
|
|
215
|
+
maxDurationSeconds: number;
|
|
216
|
+
};
|
|
217
|
+
export type CreateClipOptions = {
|
|
218
|
+
projectName: string | null | undefined;
|
|
219
|
+
source: {
|
|
220
|
+
sourceType: "asset" | "youtube";
|
|
221
|
+
assetId: string | null | undefined;
|
|
222
|
+
youtubeUrl: string | null | undefined;
|
|
223
|
+
};
|
|
224
|
+
selection: {
|
|
225
|
+
mode: ClipSelectionMode;
|
|
226
|
+
suggestionId: string | null | undefined;
|
|
227
|
+
startSeconds: number | null | undefined;
|
|
228
|
+
endSeconds: number | null | undefined;
|
|
229
|
+
};
|
|
230
|
+
target: ClipTargetOptions & {
|
|
231
|
+
aspectRatio: "9:16";
|
|
232
|
+
};
|
|
233
|
+
layout: {
|
|
234
|
+
mode: ClipLayoutMode;
|
|
235
|
+
contentTypeHint: ClipContentTypeHint | undefined;
|
|
236
|
+
};
|
|
237
|
+
captions: {
|
|
238
|
+
enabled: boolean;
|
|
239
|
+
styleId: string | null | undefined;
|
|
240
|
+
};
|
|
241
|
+
qa: {
|
|
242
|
+
mode: ClipQaMode;
|
|
243
|
+
};
|
|
244
|
+
export: {
|
|
245
|
+
autoExport: boolean;
|
|
246
|
+
};
|
|
247
|
+
};
|
|
248
|
+
export type ReselectClipOptions = {
|
|
249
|
+
clipId: string;
|
|
250
|
+
selection: CreateClipOptions["selection"];
|
|
251
|
+
target: ClipTargetOptions | null | undefined;
|
|
252
|
+
};
|
|
253
|
+
export type RepairClipOptions = {
|
|
254
|
+
clipId: string;
|
|
255
|
+
repairMode: "auto" | "prefer_split" | "prefer_focus" | "prefer_tutorial" | "move_captions_off_faces";
|
|
256
|
+
};
|
|
257
|
+
export type ExportClipOptions = {
|
|
258
|
+
clipId: string;
|
|
259
|
+
resolution: "720p" | "1080p";
|
|
260
|
+
format: "mp4" | "mov";
|
|
261
|
+
allowBlockingQaBypass: boolean;
|
|
262
|
+
};
|
|
263
|
+
export type ClipEnvelope = {
|
|
264
|
+
clip: JsonObject;
|
|
265
|
+
};
|
|
182
266
|
export type MediaAssetDetails = {
|
|
183
267
|
asset: {
|
|
184
268
|
id: string;
|
|
@@ -192,6 +276,26 @@ export type MediaAssetDetails = {
|
|
|
192
276
|
aiMood: string | null;
|
|
193
277
|
aiCameraMovement: string | null;
|
|
194
278
|
fileSizeBytes: number;
|
|
279
|
+
processingStatus: string | null | undefined;
|
|
280
|
+
processingSubstage: string | null;
|
|
281
|
+
processingError: string | null;
|
|
282
|
+
processingErrors: JsonObject;
|
|
283
|
+
processingAttempts: number | null;
|
|
284
|
+
retryable: boolean;
|
|
285
|
+
providerRequestIds: {
|
|
286
|
+
processJobRunId: string | null;
|
|
287
|
+
transcribeJobRunId: string | null;
|
|
288
|
+
providerRequestId: string | null;
|
|
289
|
+
};
|
|
290
|
+
processing_substage: string | null;
|
|
291
|
+
processing_error: string | null;
|
|
292
|
+
processing_errors: JsonObject;
|
|
293
|
+
processing_attempts: number | null;
|
|
294
|
+
provider_request_ids: {
|
|
295
|
+
process_job_run_id: string | null;
|
|
296
|
+
transcribe_job_run_id: string | null;
|
|
297
|
+
provider_request_id: string | null;
|
|
298
|
+
};
|
|
195
299
|
durationSeconds: number | null;
|
|
196
300
|
dimensionsWidth: number | null;
|
|
197
301
|
dimensionsHeight: number | null;
|
|
@@ -257,10 +361,113 @@ export type InsertAudioResult = {
|
|
|
257
361
|
};
|
|
258
362
|
txid: number | null;
|
|
259
363
|
};
|
|
364
|
+
export type UpdateAudioResult = {
|
|
365
|
+
success: boolean;
|
|
366
|
+
timeline_item_id: string;
|
|
367
|
+
duration_seconds: number;
|
|
368
|
+
volume: number;
|
|
369
|
+
fade_in_seconds: number;
|
|
370
|
+
fade_out_seconds: number;
|
|
371
|
+
txid: number | null;
|
|
372
|
+
};
|
|
373
|
+
export type UpdateMediaOverlayResult = {
|
|
374
|
+
success: boolean;
|
|
375
|
+
timelineItemId: string;
|
|
376
|
+
updated: JsonObject;
|
|
377
|
+
animationApplied: string | null;
|
|
378
|
+
keyframeCount: number;
|
|
379
|
+
message: string;
|
|
380
|
+
};
|
|
381
|
+
export type TimelineEditResult = {
|
|
382
|
+
action: string;
|
|
383
|
+
result: unknown;
|
|
384
|
+
};
|
|
385
|
+
export type TimelineTransformOptions = {
|
|
386
|
+
projectId: string;
|
|
387
|
+
timelineItemId: string;
|
|
388
|
+
positionX: number | undefined;
|
|
389
|
+
positionY: number | undefined;
|
|
390
|
+
widthPx: number | null | undefined;
|
|
391
|
+
heightPx: number | null | undefined;
|
|
392
|
+
keepAspectRatio: boolean | undefined;
|
|
393
|
+
};
|
|
394
|
+
export type TimelineMoveOptions = {
|
|
395
|
+
projectId: string;
|
|
396
|
+
timelineItemId: string;
|
|
397
|
+
newStartSeconds: number;
|
|
398
|
+
newLayerIndex: number | undefined;
|
|
399
|
+
};
|
|
400
|
+
export type TimelineDeleteOptions = {
|
|
401
|
+
projectId: string;
|
|
402
|
+
timelineItemIds: string[];
|
|
403
|
+
autoPack: boolean | undefined;
|
|
404
|
+
};
|
|
405
|
+
export type TimelineItemDeleteResult = {
|
|
406
|
+
success: boolean;
|
|
407
|
+
deleted_item_id: string;
|
|
408
|
+
deleted_item_name: string | null;
|
|
409
|
+
deleted_item_type: string | null;
|
|
410
|
+
captions_removed: number | null;
|
|
411
|
+
message: string | null;
|
|
412
|
+
};
|
|
413
|
+
export type CaptionWordsList = {
|
|
414
|
+
success: boolean;
|
|
415
|
+
words: JsonObject[];
|
|
416
|
+
pagination: JsonObject;
|
|
417
|
+
summary: JsonObject;
|
|
418
|
+
hint: string | undefined;
|
|
419
|
+
};
|
|
420
|
+
export type CaptionWordTextResult = {
|
|
421
|
+
success: boolean;
|
|
422
|
+
word_id: string;
|
|
423
|
+
old_text: string;
|
|
424
|
+
new_text: string;
|
|
425
|
+
message: string | undefined;
|
|
426
|
+
};
|
|
427
|
+
export type CaptionWordBatchTextResult = {
|
|
428
|
+
success: boolean;
|
|
429
|
+
updates: JsonObject[];
|
|
430
|
+
affected_caption_ids: string[];
|
|
431
|
+
message: string;
|
|
432
|
+
};
|
|
433
|
+
export type CaptionWordCountResult = {
|
|
434
|
+
success: boolean;
|
|
435
|
+
updated_count: number;
|
|
436
|
+
updated_word_ids: string[] | undefined;
|
|
437
|
+
emphasis: boolean | undefined;
|
|
438
|
+
message: string | undefined;
|
|
439
|
+
};
|
|
440
|
+
export type CaptionWordMutationResult = {
|
|
441
|
+
success: boolean;
|
|
442
|
+
caption_id: string;
|
|
443
|
+
affected_caption_ids: string[] | undefined;
|
|
444
|
+
deleted_word_ids: string[] | undefined;
|
|
445
|
+
merged_word_id: string | undefined;
|
|
446
|
+
split_word_ids: string[] | undefined;
|
|
447
|
+
words: JsonObject[];
|
|
448
|
+
message: string;
|
|
449
|
+
};
|
|
450
|
+
export type CaptionTrackSelectorOptions = {
|
|
451
|
+
projectId: string;
|
|
452
|
+
all: boolean | undefined;
|
|
453
|
+
captionId: string | undefined;
|
|
454
|
+
timelineItemId: string | undefined;
|
|
455
|
+
fromSeconds: number | undefined;
|
|
456
|
+
toSeconds: number | undefined;
|
|
457
|
+
};
|
|
458
|
+
export type CaptionTrackMutationResult = {
|
|
459
|
+
success: boolean;
|
|
460
|
+
action: "delete" | "hide" | "show";
|
|
461
|
+
affected_count: number;
|
|
462
|
+
caption_ids: string[];
|
|
463
|
+
timeline_item_ids: string[];
|
|
464
|
+
message: string;
|
|
465
|
+
};
|
|
260
466
|
export type CaptionThemeList = {
|
|
261
467
|
themes: JsonObject[];
|
|
262
468
|
total: number;
|
|
263
469
|
};
|
|
470
|
+
export type CaptionTheme = JsonObject;
|
|
264
471
|
export type CaptionThemePreview = {
|
|
265
472
|
preview_url: string;
|
|
266
473
|
expires_at: string;
|
|
@@ -393,6 +600,14 @@ export type AttachMediaToProjectOptions = {
|
|
|
393
600
|
durationSeconds: number | null | undefined;
|
|
394
601
|
layerIndex: number | undefined;
|
|
395
602
|
allowDuplicate: boolean | undefined;
|
|
603
|
+
positionPreset: MediaPositionPreset | undefined;
|
|
604
|
+
positionX: number | undefined;
|
|
605
|
+
positionY: number | undefined;
|
|
606
|
+
widthPx: number | undefined;
|
|
607
|
+
heightPx: number | undefined;
|
|
608
|
+
scale: number | undefined;
|
|
609
|
+
opacity: number | undefined;
|
|
610
|
+
animationPreset: MediaAnimationPreset | undefined;
|
|
396
611
|
};
|
|
397
612
|
export type ListMediaFoldersOptions = {
|
|
398
613
|
parentFolderId: string | undefined;
|
|
@@ -417,6 +632,7 @@ export type AddTextOptions = {
|
|
|
417
632
|
startSeconds: number;
|
|
418
633
|
durationSeconds: number;
|
|
419
634
|
layerIndex: number | undefined;
|
|
635
|
+
spec: JsonObject | undefined;
|
|
420
636
|
};
|
|
421
637
|
export type UpdateTextOptions = {
|
|
422
638
|
projectId: string;
|
|
@@ -424,6 +640,7 @@ export type UpdateTextOptions = {
|
|
|
424
640
|
text: string | undefined;
|
|
425
641
|
name: string | undefined;
|
|
426
642
|
spec: JsonObject | undefined;
|
|
643
|
+
durationSeconds: number | undefined;
|
|
427
644
|
};
|
|
428
645
|
export type RemoveTextOptions = {
|
|
429
646
|
projectId: string;
|
|
@@ -439,6 +656,256 @@ export type AddAudioOptions = {
|
|
|
439
656
|
fadeOutSeconds: number | undefined;
|
|
440
657
|
loop: boolean | undefined;
|
|
441
658
|
};
|
|
659
|
+
export type UpdateAudioOptions = {
|
|
660
|
+
projectId: string;
|
|
661
|
+
timelineItemId: string;
|
|
662
|
+
durationSeconds: number | undefined;
|
|
663
|
+
volume: number | undefined;
|
|
664
|
+
fadeInSeconds: number | undefined;
|
|
665
|
+
fadeOutSeconds: number | undefined;
|
|
666
|
+
};
|
|
667
|
+
export type AudioLibraryProvider = "openverse" | "freesound" | "wikimedia";
|
|
668
|
+
export type AudioLibraryProviderFilter = AudioLibraryProvider | "all";
|
|
669
|
+
export type AudioLibraryLicenseFilter = "cc0" | "public_domain" | "attribution" | "all";
|
|
670
|
+
export type AudioLibraryTypeFilter = "music" | "sound_effect" | "ambient" | "other";
|
|
671
|
+
export type StockMediaProvider = "pexels" | "freesound";
|
|
672
|
+
export type StockMediaAssetType = "image" | "video" | "audio";
|
|
673
|
+
export type StockMediaOrientation = "landscape" | "portrait" | "square";
|
|
674
|
+
export type StockAudioType = "sound_effect" | "ambient" | "background_music" | "other";
|
|
675
|
+
export type GlobalBrollLibraryAssetType = "image" | "video" | "audio";
|
|
676
|
+
export type GlobalBrollLibraryAudioType = "music" | "sound_effect" | "ambient" | "background_music" | "other";
|
|
677
|
+
export type AudioLibraryItem = {
|
|
678
|
+
provider: AudioLibraryProvider;
|
|
679
|
+
external_id: string;
|
|
680
|
+
title: string;
|
|
681
|
+
creator_name: string | null;
|
|
682
|
+
creator_url: string | null;
|
|
683
|
+
source_url: string;
|
|
684
|
+
preview_url: string | null;
|
|
685
|
+
download_url: string | null;
|
|
686
|
+
duration_seconds: number | null;
|
|
687
|
+
license_code: string;
|
|
688
|
+
license_url: string | null;
|
|
689
|
+
requires_attribution: boolean;
|
|
690
|
+
attribution_text: string | null;
|
|
691
|
+
commercial_use_allowed: boolean;
|
|
692
|
+
tags: string[];
|
|
693
|
+
};
|
|
694
|
+
export type SearchAudioLibraryOptions = {
|
|
695
|
+
query: string;
|
|
696
|
+
provider: AudioLibraryProviderFilter | undefined;
|
|
697
|
+
license: AudioLibraryLicenseFilter | undefined;
|
|
698
|
+
audioType: AudioLibraryTypeFilter | undefined;
|
|
699
|
+
minDurationSeconds: number | null | undefined;
|
|
700
|
+
maxDurationSeconds: number | null | undefined;
|
|
701
|
+
limit: number | undefined;
|
|
702
|
+
page: number | undefined;
|
|
703
|
+
};
|
|
704
|
+
export type SearchAudioLibraryResult = {
|
|
705
|
+
items: AudioLibraryItem[];
|
|
706
|
+
warnings: string[];
|
|
707
|
+
providers: AudioLibraryProvider[];
|
|
708
|
+
};
|
|
709
|
+
export type ImportAudioLibraryAssetOptions = {
|
|
710
|
+
provider: AudioLibraryProvider;
|
|
711
|
+
externalId: string;
|
|
712
|
+
folderId: string | null | undefined;
|
|
713
|
+
projectId: string | null | undefined;
|
|
714
|
+
startSeconds: number | undefined;
|
|
715
|
+
durationSeconds: number | null | undefined;
|
|
716
|
+
volume: number | undefined;
|
|
717
|
+
fadeInSeconds: number | undefined;
|
|
718
|
+
fadeOutSeconds: number | undefined;
|
|
719
|
+
loop: boolean | undefined;
|
|
720
|
+
audioType: AudioLibraryTypeFilter | undefined;
|
|
721
|
+
};
|
|
722
|
+
export type ImportAudioLibraryAssetResult = {
|
|
723
|
+
asset: {
|
|
724
|
+
id: string;
|
|
725
|
+
name: string;
|
|
726
|
+
asset_type: "audio";
|
|
727
|
+
audio_type: string;
|
|
728
|
+
duration_seconds: number | null;
|
|
729
|
+
source_url: string;
|
|
730
|
+
license_code: string;
|
|
731
|
+
license_url: string | null;
|
|
732
|
+
attribution_text: string | null;
|
|
733
|
+
};
|
|
734
|
+
imported: boolean;
|
|
735
|
+
deduped: boolean;
|
|
736
|
+
timeline_item_id: string | null;
|
|
737
|
+
txid: number | null;
|
|
738
|
+
};
|
|
739
|
+
export type StockMediaVariant = {
|
|
740
|
+
id: string;
|
|
741
|
+
label: string;
|
|
742
|
+
url: string;
|
|
743
|
+
mime_type: string;
|
|
744
|
+
width: number | null;
|
|
745
|
+
height: number | null;
|
|
746
|
+
quality: string | null;
|
|
747
|
+
};
|
|
748
|
+
export type StockMediaItem = {
|
|
749
|
+
provider: StockMediaProvider;
|
|
750
|
+
provider_asset_id: string;
|
|
751
|
+
asset_type: StockMediaAssetType;
|
|
752
|
+
title: string;
|
|
753
|
+
preview_url: string | null;
|
|
754
|
+
thumbnail_url: string | null;
|
|
755
|
+
source_url: string;
|
|
756
|
+
author_name: string | null;
|
|
757
|
+
author_url: string | null;
|
|
758
|
+
license_code: string;
|
|
759
|
+
license_url: string | null;
|
|
760
|
+
requires_attribution: boolean;
|
|
761
|
+
width: number | null;
|
|
762
|
+
height: number | null;
|
|
763
|
+
duration_seconds: number | null;
|
|
764
|
+
variants: StockMediaVariant[];
|
|
765
|
+
};
|
|
766
|
+
export type SearchStockMediaOptions = {
|
|
767
|
+
query: string;
|
|
768
|
+
assetType: StockMediaAssetType;
|
|
769
|
+
provider: StockMediaProvider | null | undefined;
|
|
770
|
+
orientation: StockMediaOrientation | null | undefined;
|
|
771
|
+
page: number | undefined;
|
|
772
|
+
limit: number | undefined;
|
|
773
|
+
};
|
|
774
|
+
export type SearchStockMediaResult = {
|
|
775
|
+
items: StockMediaItem[];
|
|
776
|
+
warnings: string[];
|
|
777
|
+
};
|
|
778
|
+
export type ImportStockMediaOptions = {
|
|
779
|
+
provider: StockMediaProvider;
|
|
780
|
+
providerAssetId: string;
|
|
781
|
+
assetType: StockMediaAssetType;
|
|
782
|
+
variantId: string | null | undefined;
|
|
783
|
+
folderId: string | null | undefined;
|
|
784
|
+
audioType: StockAudioType | undefined;
|
|
785
|
+
};
|
|
786
|
+
export type ImportStockMediaResult = {
|
|
787
|
+
asset: {
|
|
788
|
+
id: string;
|
|
789
|
+
name: string;
|
|
790
|
+
asset_type: StockMediaAssetType;
|
|
791
|
+
processing_status: string;
|
|
792
|
+
source_url: string;
|
|
793
|
+
license_code: string;
|
|
794
|
+
license_url: string | null;
|
|
795
|
+
};
|
|
796
|
+
imported: boolean;
|
|
797
|
+
deduped: boolean;
|
|
798
|
+
};
|
|
799
|
+
export type GlobalBrollLibraryItem = {
|
|
800
|
+
id: string;
|
|
801
|
+
asset_type: GlobalBrollLibraryAssetType;
|
|
802
|
+
title: string;
|
|
803
|
+
description: string;
|
|
804
|
+
tags: string[];
|
|
805
|
+
preview_url: string | null;
|
|
806
|
+
thumbnail_url: string | null;
|
|
807
|
+
mime_type: string;
|
|
808
|
+
file_size_bytes: number;
|
|
809
|
+
duration_seconds: number | null;
|
|
810
|
+
width: number | null;
|
|
811
|
+
height: number | null;
|
|
812
|
+
audio_type: GlobalBrollLibraryAudioType;
|
|
813
|
+
license_code: string;
|
|
814
|
+
license_url: string | null;
|
|
815
|
+
requires_attribution: boolean;
|
|
816
|
+
attribution_text: string | null;
|
|
817
|
+
source_url: string | null;
|
|
818
|
+
};
|
|
819
|
+
export type SearchGlobalBrollLibraryOptions = {
|
|
820
|
+
query: string | null | undefined;
|
|
821
|
+
assetType: GlobalBrollLibraryAssetType | null | undefined;
|
|
822
|
+
audioType: GlobalBrollLibraryAudioType | null | undefined;
|
|
823
|
+
limit: number | undefined;
|
|
824
|
+
offset: number | undefined;
|
|
825
|
+
};
|
|
826
|
+
export type SearchGlobalBrollLibraryResult = {
|
|
827
|
+
items: GlobalBrollLibraryItem[];
|
|
828
|
+
};
|
|
829
|
+
export type ImportGlobalBrollLibraryAssetOptions = {
|
|
830
|
+
libraryAssetId: string;
|
|
831
|
+
folderId: string | null | undefined;
|
|
832
|
+
};
|
|
833
|
+
export type ImportGlobalBrollLibraryAssetResult = {
|
|
834
|
+
asset: {
|
|
835
|
+
id: string;
|
|
836
|
+
name: string;
|
|
837
|
+
asset_type: GlobalBrollLibraryAssetType;
|
|
838
|
+
processing_status: string;
|
|
839
|
+
library_asset_id: string;
|
|
840
|
+
};
|
|
841
|
+
imported: boolean;
|
|
842
|
+
deduped: boolean;
|
|
843
|
+
};
|
|
844
|
+
export type MediaPositionPreset = "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "fullscreen" | "full-screen";
|
|
845
|
+
export type MediaAnimationPreset = "none" | "fadeIn" | "fadeOut" | "zoomIn" | "zoomOut" | "slideIn" | "slideLeft" | "slideRight" | "slideUp" | "slideDown" | "popIn" | "bounce" | "spin";
|
|
846
|
+
export type UpdateMediaOverlayOptions = {
|
|
847
|
+
projectId: string;
|
|
848
|
+
timelineItemId: string;
|
|
849
|
+
positionPreset: MediaPositionPreset | undefined;
|
|
850
|
+
positionX: number | undefined;
|
|
851
|
+
positionY: number | undefined;
|
|
852
|
+
widthPx: number | undefined;
|
|
853
|
+
heightPx: number | undefined;
|
|
854
|
+
scale: number | undefined;
|
|
855
|
+
animationPreset: MediaAnimationPreset | undefined;
|
|
856
|
+
removeAnimations: boolean | undefined;
|
|
857
|
+
blurredBackground: boolean | undefined;
|
|
858
|
+
};
|
|
859
|
+
export type CaptionWordSelectorOptions = {
|
|
860
|
+
projectId: string;
|
|
861
|
+
wordIds: string[] | undefined;
|
|
862
|
+
matchText: string | undefined;
|
|
863
|
+
matchPattern: "numbers" | "caps" | "exclamations" | undefined;
|
|
864
|
+
timelineItemId: string | undefined;
|
|
865
|
+
all: boolean | undefined;
|
|
866
|
+
fromSeconds: number | undefined;
|
|
867
|
+
toSeconds: number | undefined;
|
|
868
|
+
};
|
|
869
|
+
export type ListCaptionWordsOptions = {
|
|
870
|
+
projectId: string;
|
|
871
|
+
timelineItemId: string | undefined;
|
|
872
|
+
matchText: string | undefined;
|
|
873
|
+
limit: number | undefined;
|
|
874
|
+
offset: number | undefined;
|
|
875
|
+
};
|
|
876
|
+
export type UpdateCaptionWordTextOptions = {
|
|
877
|
+
projectId: string;
|
|
878
|
+
wordId: string;
|
|
879
|
+
newText: string;
|
|
880
|
+
};
|
|
881
|
+
export type BatchUpdateCaptionWordTextOptions = {
|
|
882
|
+
projectId: string;
|
|
883
|
+
updates: Array<{
|
|
884
|
+
word_id: string;
|
|
885
|
+
new_text: string;
|
|
886
|
+
}>;
|
|
887
|
+
};
|
|
888
|
+
export type SetCaptionWordStyleOptions = CaptionWordSelectorOptions & {
|
|
889
|
+
style: JsonObject | null;
|
|
890
|
+
clearExisting: boolean | undefined;
|
|
891
|
+
};
|
|
892
|
+
export type SetCaptionWordEmphasisOptions = CaptionWordSelectorOptions & {
|
|
893
|
+
emphasis: boolean;
|
|
894
|
+
};
|
|
895
|
+
export type DeleteCaptionWordsOptions = {
|
|
896
|
+
projectId: string;
|
|
897
|
+
wordIds: string[];
|
|
898
|
+
};
|
|
899
|
+
export type MergeCaptionWordsOptions = {
|
|
900
|
+
projectId: string;
|
|
901
|
+
wordIds: string[];
|
|
902
|
+
text: string | undefined;
|
|
903
|
+
};
|
|
904
|
+
export type SplitCaptionWordOptions = {
|
|
905
|
+
projectId: string;
|
|
906
|
+
wordId: string;
|
|
907
|
+
words: string[];
|
|
908
|
+
};
|
|
442
909
|
export type PreviewCaptionThemeOptions = {
|
|
443
910
|
settings: JsonObject;
|
|
444
911
|
sampleText: string | undefined;
|
|
@@ -446,11 +913,16 @@ export type PreviewCaptionThemeOptions = {
|
|
|
446
913
|
targetWidth: number | undefined;
|
|
447
914
|
imageFormat: "png" | "jpeg" | undefined;
|
|
448
915
|
};
|
|
916
|
+
export type UpdateCaptionThemeOptions = {
|
|
917
|
+
themeId: string;
|
|
918
|
+
name: string | undefined;
|
|
919
|
+
description: string | undefined;
|
|
920
|
+
settings: JsonObject | undefined;
|
|
921
|
+
};
|
|
449
922
|
export type StartExportOptions = {
|
|
450
923
|
projectId: string;
|
|
451
924
|
resolution: string | undefined;
|
|
452
925
|
format: string | undefined;
|
|
453
|
-
includeCaptions: boolean | undefined;
|
|
454
926
|
};
|
|
455
927
|
export type WaitExportOptions = {
|
|
456
928
|
exportId: string;
|
|
@@ -459,7 +931,8 @@ export type WaitExportOptions = {
|
|
|
459
931
|
};
|
|
460
932
|
export type SilencePlanOptions = {
|
|
461
933
|
projectId: string;
|
|
462
|
-
timelineItemId: string;
|
|
934
|
+
timelineItemId: string | undefined;
|
|
935
|
+
allMediaItems: boolean | undefined;
|
|
463
936
|
paddingMs: number | undefined;
|
|
464
937
|
silenceThresholdDb: number | undefined;
|
|
465
938
|
minSilenceDurationSeconds: number | undefined;
|
|
@@ -481,6 +954,63 @@ export type MistakeApplyOptions = MistakePlanOptions & {
|
|
|
481
954
|
deleteMistakes: boolean | undefined;
|
|
482
955
|
previewConfirmed: true;
|
|
483
956
|
};
|
|
957
|
+
export type EffectEasing = "linear" | "easeIn" | "easeOut" | "easeInOut";
|
|
958
|
+
export type ZoomEffectSettings = {
|
|
959
|
+
scale: {
|
|
960
|
+
start: number;
|
|
961
|
+
end: number;
|
|
962
|
+
} | undefined;
|
|
963
|
+
translate: {
|
|
964
|
+
start: {
|
|
965
|
+
x: number;
|
|
966
|
+
y: number;
|
|
967
|
+
};
|
|
968
|
+
end: {
|
|
969
|
+
x: number;
|
|
970
|
+
y: number;
|
|
971
|
+
};
|
|
972
|
+
} | undefined;
|
|
973
|
+
anchor: {
|
|
974
|
+
x: number;
|
|
975
|
+
y: number;
|
|
976
|
+
} | undefined;
|
|
977
|
+
style: "transition" | "hard" | undefined;
|
|
978
|
+
phase: "in" | "out" | "both" | "none" | undefined;
|
|
979
|
+
inDurationSeconds: number | undefined;
|
|
980
|
+
outDurationSeconds: number | null | undefined;
|
|
981
|
+
outScale: number | null | undefined;
|
|
982
|
+
};
|
|
983
|
+
export type MaskEffectSettings = JsonObject;
|
|
984
|
+
export type ColorGradeEffectSettings = JsonObject;
|
|
985
|
+
export type AddEffectOptions<TSettings> = {
|
|
986
|
+
projectId: string;
|
|
987
|
+
timelineItemId: string | undefined;
|
|
988
|
+
contentItemId: string | undefined;
|
|
989
|
+
effectId: string | undefined;
|
|
990
|
+
name: string | undefined;
|
|
991
|
+
startTimeSeconds: number | undefined;
|
|
992
|
+
durationSeconds: number | undefined;
|
|
993
|
+
easing: EffectEasing | undefined;
|
|
994
|
+
layerIndex: number | undefined;
|
|
995
|
+
orderIndex: number | undefined;
|
|
996
|
+
settings: TSettings | undefined;
|
|
997
|
+
};
|
|
998
|
+
export type UpdateEffectOptions<TSettings> = {
|
|
999
|
+
projectId: string;
|
|
1000
|
+
timelineItemId: string;
|
|
1001
|
+
durationSeconds: number | undefined;
|
|
1002
|
+
easing: EffectEasing | undefined;
|
|
1003
|
+
settings: TSettings | undefined;
|
|
1004
|
+
};
|
|
1005
|
+
export type EffectMutationResult = {
|
|
1006
|
+
success: true;
|
|
1007
|
+
project_id: string;
|
|
1008
|
+
timeline_item_id: string;
|
|
1009
|
+
content_item_id: string;
|
|
1010
|
+
effect_id: string;
|
|
1011
|
+
effect_type: "zoom" | "mask" | "colorgrade";
|
|
1012
|
+
txid: number | null;
|
|
1013
|
+
};
|
|
484
1014
|
export declare class BlitzReelsClient {
|
|
485
1015
|
private apiKey;
|
|
486
1016
|
private baseUrl;
|
|
@@ -508,6 +1038,29 @@ export declare class BlitzReelsClient {
|
|
|
508
1038
|
renderSnapshot: (options: SnapshotOptions) => Promise<PreviewFrame>;
|
|
509
1039
|
renderSnapshots: (options: SnapshotBatchOptions) => Promise<PreviewFrames>;
|
|
510
1040
|
};
|
|
1041
|
+
timeline: {
|
|
1042
|
+
transform: (options: TimelineTransformOptions) => Promise<TimelineEditResult>;
|
|
1043
|
+
move: (options: TimelineMoveOptions) => Promise<TimelineEditResult>;
|
|
1044
|
+
delete: (options: TimelineDeleteOptions) => Promise<TimelineEditResult>;
|
|
1045
|
+
deleteItem: (options: {
|
|
1046
|
+
projectId: string;
|
|
1047
|
+
timelineItemId: string;
|
|
1048
|
+
}) => Promise<TimelineItemDeleteResult>;
|
|
1049
|
+
};
|
|
1050
|
+
effects: {
|
|
1051
|
+
zoom: {
|
|
1052
|
+
add: (options: AddEffectOptions<ZoomEffectSettings>) => Promise<EffectMutationResult>;
|
|
1053
|
+
update: (options: UpdateEffectOptions<ZoomEffectSettings>) => Promise<EffectMutationResult>;
|
|
1054
|
+
};
|
|
1055
|
+
mask: {
|
|
1056
|
+
add: (options: AddEffectOptions<MaskEffectSettings>) => Promise<EffectMutationResult>;
|
|
1057
|
+
update: (options: UpdateEffectOptions<MaskEffectSettings>) => Promise<EffectMutationResult>;
|
|
1058
|
+
};
|
|
1059
|
+
colorgrade: {
|
|
1060
|
+
add: (options: AddEffectOptions<ColorGradeEffectSettings>) => Promise<EffectMutationResult>;
|
|
1061
|
+
update: (options: UpdateEffectOptions<ColorGradeEffectSettings>) => Promise<EffectMutationResult>;
|
|
1062
|
+
};
|
|
1063
|
+
};
|
|
511
1064
|
workspace: {
|
|
512
1065
|
getSettings: () => Promise<WorkspaceSettings>;
|
|
513
1066
|
updateSettings: (options: UpdateWorkspaceSettingsOptions) => Promise<WorkspaceSettingsUpdate>;
|
|
@@ -517,6 +1070,10 @@ export declare class BlitzReelsClient {
|
|
|
517
1070
|
get: (options: {
|
|
518
1071
|
assetId: string;
|
|
519
1072
|
}) => Promise<MediaAssetDetails>;
|
|
1073
|
+
clippingStatus: (options: {
|
|
1074
|
+
assetId: string;
|
|
1075
|
+
projectId: string | undefined;
|
|
1076
|
+
}) => Promise<JsonObject>;
|
|
520
1077
|
delete: (options: {
|
|
521
1078
|
assetId: string;
|
|
522
1079
|
}) => Promise<{
|
|
@@ -528,6 +1085,16 @@ export declare class BlitzReelsClient {
|
|
|
528
1085
|
update: (options: UpdateMediaOptions) => Promise<MediaAssetUpdateResult>;
|
|
529
1086
|
move: (options: MoveMediaOptions) => Promise<MediaMoveResult>;
|
|
530
1087
|
attachToProject: (options: AttachMediaToProjectOptions) => Promise<MediaAttachResult>;
|
|
1088
|
+
updateOverlay: (options: UpdateMediaOverlayOptions) => Promise<UpdateMediaOverlayResult>;
|
|
1089
|
+
shorts: {
|
|
1090
|
+
list: (options: {
|
|
1091
|
+
assetId: string;
|
|
1092
|
+
}) => Promise<MediaShortSuggestionList>;
|
|
1093
|
+
generate: (options: GenerateMediaShortSuggestionsOptions) => Promise<{
|
|
1094
|
+
run_id: string;
|
|
1095
|
+
}>;
|
|
1096
|
+
apply: (options: ApplyMediaShortSuggestionOptions) => Promise<ApplyMediaShortSuggestionResult>;
|
|
1097
|
+
};
|
|
531
1098
|
folders: {
|
|
532
1099
|
list: (options: ListMediaFoldersOptions) => Promise<MediaFoldersList>;
|
|
533
1100
|
create: (options: CreateMediaFolderOptions) => Promise<{
|
|
@@ -546,6 +1113,15 @@ export declare class BlitzReelsClient {
|
|
|
546
1113
|
}>;
|
|
547
1114
|
};
|
|
548
1115
|
};
|
|
1116
|
+
clips: {
|
|
1117
|
+
create: (options: CreateClipOptions) => Promise<ClipEnvelope>;
|
|
1118
|
+
get: (options: {
|
|
1119
|
+
clipId: string;
|
|
1120
|
+
}) => Promise<ClipEnvelope>;
|
|
1121
|
+
reselect: (options: ReselectClipOptions) => Promise<ClipEnvelope>;
|
|
1122
|
+
repair: (options: RepairClipOptions) => Promise<ClipEnvelope>;
|
|
1123
|
+
export: (options: ExportClipOptions) => Promise<ClipEnvelope>;
|
|
1124
|
+
};
|
|
549
1125
|
text: {
|
|
550
1126
|
add: (options: AddTextOptions) => Promise<CreateContentItemResult>;
|
|
551
1127
|
list: (options: {
|
|
@@ -560,6 +1136,19 @@ export declare class BlitzReelsClient {
|
|
|
560
1136
|
};
|
|
561
1137
|
audio: {
|
|
562
1138
|
add: (options: AddAudioOptions) => Promise<InsertAudioResult>;
|
|
1139
|
+
update: (options: UpdateAudioOptions) => Promise<UpdateAudioResult>;
|
|
1140
|
+
};
|
|
1141
|
+
audioLibrary: {
|
|
1142
|
+
search: (options: SearchAudioLibraryOptions) => Promise<SearchAudioLibraryResult>;
|
|
1143
|
+
importAsset: (options: ImportAudioLibraryAssetOptions) => Promise<ImportAudioLibraryAssetResult>;
|
|
1144
|
+
};
|
|
1145
|
+
stockMedia: {
|
|
1146
|
+
search: (options: SearchStockMediaOptions) => Promise<SearchStockMediaResult>;
|
|
1147
|
+
importAsset: (options: ImportStockMediaOptions) => Promise<ImportStockMediaResult>;
|
|
1148
|
+
};
|
|
1149
|
+
library: {
|
|
1150
|
+
search: (options: SearchGlobalBrollLibraryOptions) => Promise<SearchGlobalBrollLibraryResult>;
|
|
1151
|
+
importAsset: (options: ImportGlobalBrollLibraryAssetOptions) => Promise<ImportGlobalBrollLibraryAssetResult>;
|
|
563
1152
|
};
|
|
564
1153
|
silence: {
|
|
565
1154
|
plan: (options: SilencePlanOptions) => Promise<unknown>;
|
|
@@ -570,7 +1159,19 @@ export declare class BlitzReelsClient {
|
|
|
570
1159
|
apply: (options: MistakeApplyOptions) => Promise<unknown>;
|
|
571
1160
|
};
|
|
572
1161
|
captions: {
|
|
1162
|
+
listWords: (options: ListCaptionWordsOptions) => Promise<CaptionWordsList>;
|
|
1163
|
+
updateWordText: (options: UpdateCaptionWordTextOptions) => Promise<CaptionWordTextResult>;
|
|
1164
|
+
batchUpdateWordText: (options: BatchUpdateCaptionWordTextOptions) => Promise<CaptionWordBatchTextResult>;
|
|
1165
|
+
setWordStyle: (options: SetCaptionWordStyleOptions) => Promise<CaptionWordCountResult>;
|
|
1166
|
+
setWordEmphasis: (options: SetCaptionWordEmphasisOptions) => Promise<CaptionWordCountResult>;
|
|
1167
|
+
deleteWords: (options: DeleteCaptionWordsOptions) => Promise<CaptionWordMutationResult>;
|
|
1168
|
+
delete: (options: CaptionTrackSelectorOptions) => Promise<CaptionTrackMutationResult>;
|
|
1169
|
+
hide: (options: CaptionTrackSelectorOptions) => Promise<CaptionTrackMutationResult>;
|
|
1170
|
+
show: (options: CaptionTrackSelectorOptions) => Promise<CaptionTrackMutationResult>;
|
|
1171
|
+
mergeWords: (options: MergeCaptionWordsOptions) => Promise<CaptionWordMutationResult>;
|
|
1172
|
+
splitWord: (options: SplitCaptionWordOptions) => Promise<CaptionWordMutationResult>;
|
|
573
1173
|
listThemes: () => Promise<CaptionThemeList>;
|
|
1174
|
+
updateTheme: (options: UpdateCaptionThemeOptions) => Promise<CaptionTheme>;
|
|
574
1175
|
setDefaultTheme: (options: {
|
|
575
1176
|
themeId: string;
|
|
576
1177
|
}) => Promise<{
|