@adobe/premierepro 26.2.0

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.
@@ -0,0 +1,4388 @@
1
+ /*
2
+ * Copyright 2026 Adobe. All rights reserved.
3
+ *
4
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
5
+ * you may not use this file except in compliance with the License. You may obtain a copy
6
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
7
+ *
8
+ * Unless required by applicable law or agreed to in writing, software distributed under
9
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
10
+ * OF ANY KIND, either express or implied. See the License for the specific language
11
+ * governing permissions and limitations under the License.
12
+ */
13
+
14
+ export declare type premierepro = {
15
+ Action: Action;
16
+ AddTransitionOptions: AddTransitionOptions;
17
+ AppPreference: AppPreferenceStatic;
18
+ Application: Application;
19
+ AudioClipTrackItem: AudioClipTrackItemStatic;
20
+ AudioComponentChain: AudioComponentChainStatic;
21
+ AudioFilterComponent: AudioFilterComponentStatic;
22
+ AudioFilterFactory: AudioFilterFactoryStatic;
23
+ AudioTrack: AudioTrackStatic;
24
+ CaptionTrack: CaptionTrackStatic;
25
+ ClipProjectItem: ClipProjectItemStatic;
26
+ CloseProjectOptions: CloseProjectOptions;
27
+ Color: Color;
28
+ Component: Component;
29
+ ComponentParam: ComponentParam;
30
+ CompoundAction: CompoundAction;
31
+ EncoderManager: EncoderManagerStatic;
32
+ Exporter: ExporterStatic;
33
+ FolderItem: FolderItemStatic;
34
+ FootageInterpretation: FootageInterpretation;
35
+ FrameRate: FrameRateStatic;
36
+ Guid: GuidStatic;
37
+ IngestSettings: IngestSettings;
38
+ Keyframe: KeyframeStatic;
39
+ Marker: MarkerStatic;
40
+ Markers: MarkersStatic;
41
+ Media: Media;
42
+ Metadata: MetadataStatic;
43
+ OpenProjectOptions: OpenProjectOptions;
44
+ OperationCompleteEvent: OperationCompleteEventStatic;
45
+ PRProduction: PRProductionStatic;
46
+ PointF: PointF;
47
+ PointKeyframe: PointKeyframe;
48
+ Project: ProjectStatic;
49
+ ProjectClosedEvent: ProjectClosedEventStatic;
50
+ ProjectColorSettings: ProjectColorSettings;
51
+ ProjectConverter: ProjectConverterStatic;
52
+ ProjectEvent: ProjectEventStatic;
53
+ ProjectItem: ProjectItemStatic;
54
+ ProjectItemSelection: ProjectItemSelection;
55
+ ProjectSettings: ProjectSettingsStatic;
56
+ ProjectUtils: ProjectUtilsStatic;
57
+ Properties: PropertiesStatic;
58
+ RectF: RectF;
59
+ ScratchDiskSettings: ScratchDiskSettingsStatic;
60
+ Sequence: SequenceStatic;
61
+ SequenceEditor: SequenceEditorStatic;
62
+ SequenceSettings: SequenceSettingsStatic;
63
+ SequenceUtils: SequenceUtilsStatic;
64
+ SnapEvent: SnapEventStatic;
65
+ SourceMonitor: SourceMonitorStatic;
66
+ TextSegments: TextSegmentsStatic;
67
+ TickTime: TickTimeStatic;
68
+ TimeDisplay: TimeDisplay;
69
+ TrackItemSelection: TrackItemSelectionStatic;
70
+ TransitionFactory: TransitionFactoryStatic;
71
+ UniqueSerializeable: UniqueSerializeableStatic;
72
+ Utils: UtilsStatic;
73
+ VideoClipTrackItem: VideoClipTrackItemStatic;
74
+ VideoComponentChain: VideoComponentChainStatic;
75
+ VideoFilterComponent: VideoFilterComponentStatic;
76
+ VideoFilterFactory: VideoFilterFactoryStatic;
77
+ VideoTrack: VideoTrackStatic;
78
+ VideoTransition: VideoTransitionStatic;
79
+ EventManager: EventManagerStatic;
80
+ Transcript: TranscriptStatic;
81
+ Constants: typeof Constants;
82
+ };
83
+
84
+ export declare type Action = {};
85
+
86
+ export declare type AddTransitionOptions = {
87
+ /**
88
+ * Constructs a new instance of the AddTransitionOptions class.
89
+ * @constructor
90
+ */
91
+ new (): AddTransitionOptions;
92
+ (): AddTransitionOptions;
93
+
94
+ /**
95
+ * Set whether to apply transition to the start or end of trackitem
96
+ *
97
+ * @param applyToStart
98
+ */
99
+ setApplyToStart(applyToStart: boolean): AddTransitionOptions;
100
+
101
+ /**
102
+ * Set whether transition should be applied to one/both sides
103
+ *
104
+ * @param forceSingleSided
105
+ */
106
+ setForceSingleSided(forceSingleSided: boolean): AddTransitionOptions;
107
+
108
+ /**
109
+ * Sets the transitionAlignment of the transition
110
+ *
111
+ * @param transitionAlignment
112
+ */
113
+ setTransitionAlignment(transitionAlignment: number): AddTransitionOptions;
114
+
115
+ /**
116
+ * Sets the duration of transition
117
+ *
118
+ * @param tickTime Sets the duration of transition in TickTime
119
+ */
120
+ setDuration(tickTime: TickTime): AddTransitionOptions;
121
+
122
+ /**
123
+ * Get whether to apply transition to the start or end of trackitem
124
+ * @readonly
125
+ */
126
+ readonly applyToStart: boolean;
127
+
128
+ /**
129
+ * Get whether transition should be applied to one/both sides
130
+ * @readonly
131
+ */
132
+ readonly forceSingleSided: boolean;
133
+
134
+ /**
135
+ * Gets the transitionAlignment of transition
136
+ * @readonly
137
+ */
138
+ readonly transitionAlignment: number;
139
+
140
+ /**
141
+ * Gets the duration of transition
142
+ * @readonly
143
+ */
144
+ readonly duration: TickTime;
145
+ };
146
+
147
+ export declare type AppPreferenceStatic = {
148
+ /**
149
+ * Set backend preference using given list of property keys. The parameters are <key, value (number, boolean or string), persistence flag>
150
+ *
151
+ * @param key App preference key to set
152
+ * @param value Value to set for the preference key
153
+ * @param persistenceFlag Indicates whether the preference should be persisted or not
154
+ */
155
+ setValue(
156
+ key: Constants.PreferenceKey,
157
+ value: boolean | string | number,
158
+ persistenceFlag: Constants.PropertyType
159
+ ): boolean;
160
+
161
+ /**
162
+ * Get preference value in native string form
163
+ *
164
+ * @param preferenceKey App preference key to get
165
+ */
166
+ getValue(preferenceKey: Constants.PreferenceKey): string;
167
+
168
+ /**
169
+ * Preference string key used to modify auto-peak generation settings
170
+ * @readonly
171
+ */
172
+ readonly KEY_AUTO_PEAK_GENERATION: string;
173
+
174
+ /**
175
+ * Preference string key used to modify import workspace settings
176
+ * @readonly
177
+ */
178
+ readonly KEY_IMPORT_WORKSPACE: string;
179
+
180
+ /**
181
+ * Preference string key used to modify show quickstart dialog settings
182
+ * @readonly
183
+ */
184
+ readonly KEY_SHOW_QUICKSTART_DIALOG: string;
185
+
186
+ /**
187
+ * Property is persistent in backend and shared across cloud project.
188
+ * @readonly
189
+ */
190
+ readonly PROPERTY_PERSISTENT: number;
191
+
192
+ /**
193
+ * Property is not persisted and will be cleared when the project closes.
194
+ * @readonly
195
+ */
196
+ readonly PROPERTY_NON_PERSISTENT: number;
197
+ };
198
+
199
+ export declare type AppPreference = {};
200
+
201
+ export declare type Application = {
202
+ /**
203
+ * @readonly
204
+ */
205
+ readonly version: string;
206
+ };
207
+
208
+ export declare type AudioClipTrackItemStatic = {
209
+ /**
210
+ * Empty Track Item Type
211
+ * @readonly
212
+ */
213
+ readonly TRACKITEMTYPE_EMPTY: number;
214
+
215
+ /**
216
+ * Clip Track Item Type
217
+ * @readonly
218
+ */
219
+ readonly TRACKITEMTYPE_CLIP: number;
220
+
221
+ /**
222
+ * Transition Track Item Type
223
+ * @readonly
224
+ */
225
+ readonly TRACKITEMTYPE_TRANSITION: number;
226
+
227
+ /**
228
+ * Previe Track Item Type
229
+ * @readonly
230
+ */
231
+ readonly TRACKITEMTYPE_PREVIEW: number;
232
+
233
+ /**
234
+ * Feedback Track Item Type
235
+ * @readonly
236
+ */
237
+ readonly TRACKITEMTYPE_FEEDBACK: number;
238
+ };
239
+
240
+ export declare type AudioClipTrackItem = {
241
+ /**
242
+ * Returns the value of internal matchname for this trackItem
243
+ */
244
+ getMatchName(): Promise<string>;
245
+
246
+ /**
247
+ * Returns the display name for trackItem
248
+ */
249
+ getName(): Promise<string>;
250
+
251
+ /**
252
+ * Returns if trackItem is selected or not
253
+ */
254
+ getIsSelected(): Promise<boolean>;
255
+
256
+ /**
257
+ * Returns the value of speed of the trackItem
258
+ */
259
+ getSpeed(): Promise<number>;
260
+
261
+ /**
262
+ * Returns true if the trackitem is an adjustment layer
263
+ */
264
+ isAdjustmentLayer(): Promise<boolean>;
265
+
266
+ /**
267
+ * Returns true if the trackitem is reversed
268
+ */
269
+ isSpeedReversed(): Promise<number>;
270
+
271
+ /**
272
+ * Returns an action that moves the inPoint of the track item to a new time, by shifting it by a number of seconds.
273
+ *
274
+ * @param tickTime
275
+ */
276
+ createMoveAction(tickTime: TickTime): Action;
277
+
278
+ /**
279
+ * Returns a TickTime object representing the track item in point relative to the start time of the project item referenced by this track item.
280
+ */
281
+ getInPoint(): Promise<TickTime>;
282
+
283
+ /**
284
+ * Returns a TickTime object representing the track item out point relative to the start time of the project item referenced by this track item.
285
+ */
286
+ getOutPoint(): Promise<TickTime>;
287
+
288
+ /**
289
+ * Create SetInPointAction for setting the track item in point relative to the start time of the project item referenced by this track item
290
+ *
291
+ * @param tickTime Sets the In-Point in TickTime
292
+ */
293
+ createSetInPointAction(tickTime: TickTime): Action;
294
+
295
+ /**
296
+ * Create SetOutPointAction for setting the track item out point relative to the start time of the project item referenced by this track item
297
+ *
298
+ * @param tickTime Sets the Out-Point in TickTime
299
+ */
300
+ createSetOutPointAction(tickTime: TickTime): Action;
301
+
302
+ /**
303
+ * Returns a TickTime object representing the starting sequence time of this track item relative to the sequence start time.
304
+ */
305
+ getStartTime(): Promise<TickTime>;
306
+
307
+ /**
308
+ * Returns a TickTime object representing the ending sequence time of this track item relative to the sequence start time.
309
+ */
310
+ getEndTime(): Promise<TickTime>;
311
+
312
+ /**
313
+ * Create set start time action for sequence
314
+ *
315
+ * @param tickTime
316
+ */
317
+ createSetStartAction(tickTime: TickTime): Action;
318
+
319
+ /**
320
+ * Create set end time action for sequence
321
+ *
322
+ * @param tickTime
323
+ */
324
+ createSetEndAction(tickTime: TickTime): Action;
325
+
326
+ /**
327
+ * Returns timecode representing the duration of this track item relative to the sequence start.
328
+ */
329
+ getDuration(): Promise<TickTime>;
330
+
331
+ /**
332
+ * Index representing the type of this track item.
333
+ */
334
+ getType(): Promise<number>;
335
+
336
+ /**
337
+ * Returns true if trackitem is muted/disabled
338
+ */
339
+ isDisabled(): Promise<boolean>;
340
+
341
+ /**
342
+ * Returns an action that enables/disables the trackItem
343
+ *
344
+ * @param disabled
345
+ */
346
+ createSetDisabledAction(disabled: boolean): Action;
347
+
348
+ /**
349
+ * Returns an action that renames the trackItem
350
+ *
351
+ * @param inName
352
+ */
353
+ createSetNameAction(inName: string): Action;
354
+
355
+ /**
356
+ * Returns UUID representing the underlying media type of this track item
357
+ */
358
+ getMediaType(): Promise<Guid>;
359
+
360
+ /**
361
+ * Index representing the track index of the track this track item belongs to
362
+ */
363
+ getTrackIndex(): Promise<number>;
364
+
365
+ /**
366
+ * Returns the project item for this track item.
367
+ */
368
+ getProjectItem(): Promise<ProjectItem>;
369
+
370
+ /**
371
+ * Returns AudioComponentChain
372
+ */
373
+ getComponentChain(): Promise<AudioComponentChain>;
374
+ };
375
+
376
+ export declare type AudioComponentChainStatic = {};
377
+
378
+ export declare type AudioComponentChain = {
379
+ /**
380
+ * Creates and returns an insert component action
381
+ *
382
+ * @param component Audio filter component
383
+ * @param componentInsertionIndex Index which the component shall be inserted
384
+ */
385
+ createInsertComponentAction(
386
+ component: Component | AudioFilterComponent,
387
+ componentInsertionIndex: number
388
+ ): Action;
389
+
390
+ /**
391
+ * Creates and returns an append component action
392
+ *
393
+ * @param component Audio filter component
394
+ */
395
+ createAppendComponentAction(component: Component | AudioFilterComponent): Action;
396
+
397
+ /**
398
+ * Creates and returns an remove component action
399
+ *
400
+ * @param component Audio filter component
401
+ */
402
+ createRemoveComponentAction(component: Component | AudioFilterComponent): Action;
403
+
404
+ /**
405
+ * Returns the component at the given index
406
+ *
407
+ * @param componentIndex
408
+ * @returns Returns the component at the given index
409
+ */
410
+ getComponentAtIndex(componentIndex: number): Component;
411
+
412
+ /**
413
+ * Gets the number of components in the component chain
414
+ */
415
+ getComponentCount(): number;
416
+ };
417
+
418
+ export declare type AudioFilterComponentStatic = {};
419
+
420
+ export declare type AudioFilterComponent = {};
421
+
422
+ export declare type AudioFilterFactoryStatic = {
423
+ /**
424
+ * Creates a new audio filter component based on the input display name and trackItem for applying the audio filter
425
+ *
426
+ * @param displayName
427
+ * @param inAudioClipTrackItem
428
+ */
429
+ createComponentByDisplayName(
430
+ displayName: string,
431
+ inAudioClipTrackItem: AudioClipTrackItem
432
+ ): Promise<AudioFilterComponent>;
433
+
434
+ /**
435
+ * Returns an array of audio filter displayNames
436
+ */
437
+ getDisplayNames(): Promise<string[]>;
438
+ };
439
+
440
+ export declare type AudioFilterFactory = {};
441
+
442
+ export declare type AudioTrackStatic = {
443
+ /**
444
+ * Event Object for Track changed
445
+ * @readonly
446
+ */
447
+ readonly EVENT_TRACK_CHANGED: string;
448
+
449
+ /**
450
+ * Event Object for Track Info Changed
451
+ * @readonly
452
+ */
453
+ readonly EVENT_TRACK_INFO_CHANGED: string;
454
+
455
+ /**
456
+ * Event Object for Track Lock Changed
457
+ * @readonly
458
+ */
459
+ readonly EVENT_TRACK_LOCK_CHANGED: string;
460
+ };
461
+
462
+ export declare type AudioTrack = {
463
+ /**
464
+ * sets the mute state of the track to muted/unmuted
465
+ *
466
+ * @param mute
467
+ */
468
+ setMute(mute: boolean): Promise<boolean>;
469
+
470
+ /**
471
+ * UUID representing the underlying media type of this track
472
+ */
473
+ getMediaType(): Promise<Guid>;
474
+
475
+ /**
476
+ * Index representing the track index of this track within the track group.
477
+ */
478
+ getIndex(): Promise<number>;
479
+
480
+ /**
481
+ * Get mute state of the track
482
+ */
483
+ isMuted(): Promise<boolean>;
484
+
485
+ /**
486
+ * Returns array of AudioClipTrackItem from the track item type
487
+ *
488
+ * @param trackItemType Constants.TrackItemType.CLIP, Constants.TrackItemType.TRANSITION etc..
489
+ * @param includeEmptyTrackItems
490
+ */
491
+ getTrackItems(
492
+ trackItemType: Constants.TrackItemType,
493
+ includeEmptyTrackItems: boolean
494
+ ): AudioClipTrackItem[];
495
+
496
+ /**
497
+ * Get the name of the track
498
+ * @readonly
499
+ */
500
+ readonly name: string;
501
+
502
+ /**
503
+ * The ID of the track within the TrackGroup
504
+ * @readonly
505
+ */
506
+ readonly id: number;
507
+ };
508
+
509
+ export declare type CaptionTrackStatic = {};
510
+
511
+ export declare type CaptionTrack = {
512
+ /**
513
+ * sets the mute state of the track to muted/unmuted
514
+ *
515
+ * @param mute
516
+ */
517
+ setMute(mute: boolean): Promise<boolean>;
518
+
519
+ /**
520
+ * UUID representing the underlying media type of this track
521
+ */
522
+ getMediaType(): Promise<Guid>;
523
+
524
+ /**
525
+ * Index representing the track index of this track within the track group.
526
+ */
527
+ getIndex(): Promise<number>;
528
+
529
+ /**
530
+ * Get mute state of the track
531
+ */
532
+ isMuted(): Promise<boolean>;
533
+
534
+ /**
535
+ * Returns the track items of the specified media type from the given track
536
+ *
537
+ * @param trackItemType
538
+ * @param includeEmptyTrackItems
539
+ */
540
+ getTrackItems(trackItemType: number, includeEmptyTrackItems: boolean): [];
541
+
542
+ /**
543
+ * Get the name of the track
544
+ * @readonly
545
+ */
546
+ readonly name: string;
547
+
548
+ /**
549
+ * The ID of the track within the TrackGroup
550
+ * @readonly
551
+ */
552
+ readonly id: number;
553
+ };
554
+
555
+ export declare type ClipProjectItemStatic = {
556
+ /**
557
+ * Cast ProjectItem in to ClipProjectItem
558
+ *
559
+ * @param projectItem
560
+ */
561
+ cast(projectItem: ProjectItem): ClipProjectItem;
562
+ };
563
+
564
+ export declare type ClipProjectItem = {
565
+ /**
566
+ * Get Guid of Input LUT overridden on media
567
+ */
568
+ getInputLUTID(): Promise<string>;
569
+
570
+ /**
571
+ * Create action for setting Guid of Input LUT on media. This applies for Video Clips only.
572
+ *
573
+ * @param stringLUTID
574
+ */
575
+ createSetInputLUTIDAction(stringLUTID: string): Action;
576
+
577
+ /**
578
+ * Returns true if the project item is a sequence
579
+ */
580
+ isSequence(): Promise<boolean>;
581
+
582
+ /**
583
+ * Returns true if Premiere Pro can change the path associated with this project item; otherwise, returns false
584
+ */
585
+ canChangeMediaPath(): Promise<boolean>;
586
+
587
+ /**
588
+ * Returns true if the media is offline
589
+ */
590
+ isOffline(): Promise<boolean>;
591
+
592
+ /**
593
+ * Indicates whether it is possible to attach a proxy to this project item.
594
+ */
595
+ canProxy(): Promise<boolean>;
596
+
597
+ /**
598
+ * Returns the proxy path if the project item has a proxy attached
599
+ */
600
+ getProxyPath(): Promise<string>;
601
+
602
+ /**
603
+ * Indicates whether a proxy has already been attached to the project item.
604
+ */
605
+ hasProxy(): Promise<boolean>;
606
+
607
+ /**
608
+ * Attach proxy or high resolution footage to projectItem and returns true if successful. Not undoable.
609
+ *
610
+ * @param mediaPath
611
+ * @param isHiRes
612
+ * @param inMakeAlternateLinkInTeamProjects
613
+ */
614
+ attachProxy(
615
+ mediaPath: string,
616
+ isHiRes: boolean,
617
+ inMakeAlternateLinkInTeamProjects?: boolean
618
+ ): Promise<boolean>;
619
+
620
+ /**
621
+ * Returns array of project's items with media paths containing match string
622
+ *
623
+ * @param matchString
624
+ * @param ignoreSubclips
625
+ */
626
+ findItemsMatchingMediaPath(matchString: string, ignoreSubclips?: boolean): Promise<ProjectItem[]>;
627
+
628
+ /**
629
+ * Updates representation of the media associated with the project item
630
+ */
631
+ refreshMedia(): Promise<boolean>;
632
+
633
+ /**
634
+ * Returns an action which sets the media offline
635
+ */
636
+ createSetOfflineAction(): Action;
637
+
638
+ /**
639
+ * Get the footage interpretation object for project item
640
+ */
641
+ getFootageInterpretation(): Promise<FootageInterpretation>;
642
+
643
+ /**
644
+ * Set the footage interpretation object for project item
645
+ *
646
+ * @param footageInterpretation
647
+ */
648
+ createSetFootageInterpretationAction(footageInterpretation: FootageInterpretation): Action;
649
+
650
+ /**
651
+ * Change media file path of projectItem and returns true if successful. Not undoable.
652
+ *
653
+ * @param newPath
654
+ * @param overrideCompatibilityCheck
655
+ */
656
+ changeMediaFilePath(newPath: string, overrideCompatibilityCheck?: boolean): Promise<boolean>;
657
+
658
+ /**
659
+ * Returns true if the clip Project item is a merged clip
660
+ */
661
+ isMergedClip(): Promise<boolean>;
662
+
663
+ /**
664
+ * Returns true if the clip Project item is a multicam clip
665
+ */
666
+ isMulticamClip(): Promise<boolean>;
667
+
668
+ /**
669
+ * Get GUID of LUT embedded in media
670
+ */
671
+ getEmbeddedLUTID(): Promise<string>;
672
+
673
+ /**
674
+ * Returns an action which sets the scale to frame to true
675
+ */
676
+ createSetScaleToFrameSizeAction(): Action;
677
+
678
+ /**
679
+ * Returns action that renames projectItem
680
+ *
681
+ * @param inName
682
+ */
683
+ createSetNameAction(inName: string): Action;
684
+
685
+ /**
686
+ * Get color label index of projectItem
687
+ */
688
+ getColorLabelIndex(): Promise<number>;
689
+
690
+ /**
691
+ * Create an action for set color label to projectItem by index
692
+ *
693
+ * @param inColorLabelIndex
694
+ */
695
+ createSetColorLabelAction(inColorLabelIndex: number): Action;
696
+
697
+ /**
698
+ * Get the parent Project of this projectItem.
699
+ */
700
+ getProject(): Promise<Project>;
701
+
702
+ /**
703
+ * Get content type of the Project item
704
+ */
705
+ getContentType(): Promise<Constants.ContentType>;
706
+
707
+ /**
708
+ * Get the sequence of the Project item
709
+ */
710
+ getSequence(): Promise<Sequence>;
711
+
712
+ /**
713
+ * Get the in point of the Project item
714
+ *
715
+ * @param mediaType Media type can be audio, video or data/caption
716
+ */
717
+ getInPoint(mediaType: Constants.MediaType): Promise<TickTime>;
718
+
719
+ /**
720
+ * Get the out point of the Project item
721
+ *
722
+ * @param mediaType Media type can be audio, video or data/caption
723
+ */
724
+ getOutPoint(mediaType: Constants.MediaType): Promise<TickTime>;
725
+
726
+ /**
727
+ * Get the media file path of the Project item.
728
+ */
729
+ getMediaFilePath(): Promise<string>;
730
+
731
+ /**
732
+ * Get the media file path of the Project item.
733
+ *
734
+ * @param mediaType Media type can be audio, video or data/caption
735
+ */
736
+ getComponentChain(mediaType: Constants.MediaType): Promise<string>;
737
+
738
+ /**
739
+ * Returns an action which Sets the in point of the Project item
740
+ *
741
+ * @param tickTime
742
+ */
743
+ createSetInPointAction(tickTime: TickTime): Action;
744
+
745
+ /**
746
+ * Returns an action which sets Override pixel aspect ratio
747
+ *
748
+ * @param inNumerator
749
+ * @param inDenominator
750
+ */
751
+ createSetOverridePixelAspectRatioAction(inNumerator: number, inDenominator: number): Action;
752
+
753
+ /**
754
+ * Returns an action which sets the override frame rate
755
+ *
756
+ * @param inOverriddenFrameRateValue
757
+ */
758
+ createSetOverrideFrameRateAction(inOverriddenFrameRateValue: number): Action;
759
+
760
+ /**
761
+ * Returns an action which Sets the in point of the Project item
762
+ *
763
+ * @param tickTime
764
+ */
765
+ createSetOutPointAction(tickTime: TickTime): Action;
766
+
767
+ /**
768
+ * Set the in or out point of the Project item
769
+ *
770
+ * @param inPoint
771
+ * @param outPoint
772
+ */
773
+ createSetInOutPointsAction(inPoint: TickTime, outPoint: TickTime): Action;
774
+
775
+ /**
776
+ * Create Clear the in or out point of the Project item action
777
+ */
778
+ createClearInOutPointsAction(): Action;
779
+
780
+ /**
781
+ * Return media associated with clipProjectItem
782
+ */
783
+ getMedia(): Promise<Media>;
784
+
785
+ /**
786
+ * Return originating project path associated with clipProjectItem
787
+ */
788
+ getOriginatingProjectPath(): Promise<string>;
789
+
790
+ /**
791
+ * Get the type of the Project Item.
792
+ * @readonly
793
+ */
794
+ readonly type: number;
795
+
796
+ /**
797
+ * The name of this project item.
798
+ * @readonly
799
+ */
800
+ readonly name: string;
801
+ };
802
+
803
+ export declare type CloseProjectOptions = {
804
+ /**
805
+ * Constructs a new instance of the CloseProjectOptions class.
806
+ * @constructor
807
+ */
808
+ new (): CloseProjectOptions;
809
+ (): CloseProjectOptions;
810
+
811
+ /**
812
+ * Set whether to prompt if a project is dirty on project open/close
813
+ *
814
+ * @param promptIfDirty
815
+ */
816
+ setPromptIfDirty(promptIfDirty: boolean): CloseProjectOptions;
817
+
818
+ /**
819
+ * Set whether to show the cancel button on project open/close
820
+ *
821
+ * @param showCancelButton
822
+ */
823
+ setShowCancelButton(showCancelButton: boolean): CloseProjectOptions;
824
+
825
+ /**
826
+ * Set whether the app should be prepared to quit when open/closing a project
827
+ *
828
+ * @param isAppBeingPreparedToQuit
829
+ */
830
+ setIsAppBeingPreparedToQuit(isAppBeingPreparedToQuit: boolean): CloseProjectOptions;
831
+
832
+ /**
833
+ * Set whether to save your workspaces when opening/closing a project
834
+ *
835
+ * @param isAppBeingPreparedToQuit
836
+ */
837
+ setSaveWorkspace(isAppBeingPreparedToQuit: boolean): CloseProjectOptions;
838
+
839
+ /**
840
+ * Get whether a prompt is shown if a project is dirty on project open/close
841
+ * @readonly
842
+ */
843
+ readonly promptIfDirty: boolean;
844
+
845
+ /**
846
+ * Get whether the cancel button is shown on project open/close
847
+ * @readonly
848
+ */
849
+ readonly showCancelButton: boolean;
850
+
851
+ /**
852
+ * Get whether the app is prepared to quit when open/closing a project
853
+ * @readonly
854
+ */
855
+ readonly isAppBeingPreparedToQuit: boolean;
856
+
857
+ /**
858
+ * Get whether your workspaces are saved when opening/closing a project
859
+ * @readonly
860
+ */
861
+ readonly saveWorkspace: boolean;
862
+ };
863
+
864
+ export declare type Color = {
865
+ /**
866
+ * Constructs a new instance of the Color class.
867
+ * @constructor
868
+ *
869
+ * @param [red]
870
+ * @param [green]
871
+ * @param [blue]
872
+ * @param [alpha]
873
+ */
874
+ new (red?: number, green?: number, blue?: number, alpha?: number): Color;
875
+ (red?: number, green?: number, blue?: number, alpha?: number): Color;
876
+
877
+ /**
878
+ * Returns true if the given ColorObject is equal to this ColorObject
879
+ *
880
+ * @param colorObject
881
+ */
882
+ equals(colorObject: Color): boolean;
883
+
884
+ /**
885
+ * Read/Write property to get/set red value of color object
886
+ */
887
+ red: number;
888
+
889
+ /**
890
+ * Read/Write property to get/set green value of color object
891
+ */
892
+ green: number;
893
+
894
+ /**
895
+ * Read/Write property to get/set blue value of color object
896
+ */
897
+ blue: number;
898
+
899
+ /**
900
+ * Read/Write property to get/set alpha value of color object
901
+ */
902
+ alpha: number;
903
+ };
904
+
905
+ export declare type Component = {
906
+ /**
907
+ * Get a parameter from the component based on the given input index. Parameter indexes are zero-based, and the actual is defined exclusively by the component itself.
908
+ *
909
+ * @param paramIndex
910
+ */
911
+ getParam(paramIndex?: number): ComponentParam;
912
+
913
+ /**
914
+ * Returned Promise will be fullfilled with the value of internal matchname for this component
915
+ */
916
+ getMatchName(): Promise<string>;
917
+
918
+ /**
919
+ * Returned Promise will be fullfilled with the value of display name for this component
920
+ */
921
+ getDisplayName(): Promise<string>;
922
+
923
+ /**
924
+ * Gets the number of param in the component
925
+ */
926
+ getParamCount(): number;
927
+ };
928
+
929
+ export declare type ComponentParam = {
930
+ /**
931
+ * Creates and returns a keyframe initialised with the ComponentParam's type and passed in value. This throws if the passed in value is not compatible with the component param type
932
+ *
933
+ * @param inValue Input could be number, string, boolean, PointF, or Color depend on effect param type
934
+ */
935
+ createKeyframe(inValue: number | string | boolean | PointF | Color): Keyframe;
936
+
937
+ /**
938
+ * Gets the value of component Param at the given time
939
+ *
940
+ * @param time The time at which to get the value of the component param
941
+ */
942
+ getValueAtTime(time: TickTime): Promise<number | string | boolean | PointF | Color>;
943
+
944
+ /**
945
+ * Find sthe nearest key for the given time
946
+ *
947
+ * @param inTime
948
+ * @param outTime
949
+ */
950
+ findNearestKeyframe(inTime: TickTime, outTime: TickTime): Keyframe;
951
+
952
+ /**
953
+ * find the next keyframe for the given time
954
+ *
955
+ * @param inTime
956
+ */
957
+ findNextKeyframe(inTime: TickTime): Keyframe;
958
+
959
+ /**
960
+ * find the previous keyframe for the given time
961
+ *
962
+ * @param inTime
963
+ */
964
+ findPreviousKeyframe(inTime: TickTime): Keyframe;
965
+
966
+ /**
967
+ * Returns an action which removes keyframe at specific time
968
+ *
969
+ * @param inTime
970
+ * @param UpdateUI
971
+ */
972
+ createRemoveKeyframeAction(inTime: TickTime, UpdateUI?: boolean): Action;
973
+
974
+ /**
975
+ * Returns an action which removes keyframe at specific time range
976
+ *
977
+ * @param inTime
978
+ * @param outTime
979
+ * @param UpdateUI
980
+ */
981
+ createRemoveKeyframeRangeAction(inTime: TickTime, outTime: TickTime, UpdateUI?: boolean): Action;
982
+
983
+ /**
984
+ * Creates and returns an action object which can be used to set the value of a non-time varying component
985
+ *
986
+ * @param inKeyFrame
987
+ * @param inSafeForPlayback
988
+ */
989
+ createSetValueAction(inKeyFrame: Keyframe, inSafeForPlayback?: boolean): Action;
990
+
991
+ /**
992
+ * Creates and returns an action object which can be used to add a keyframe component
993
+ *
994
+ * @param inKeyFrame
995
+ */
996
+ createAddKeyframeAction(inKeyFrame: Keyframe): Action;
997
+
998
+ /**
999
+ * Creates and returns an action object to set the component to be time varying
1000
+ *
1001
+ * @param inTimeVarying
1002
+ */
1003
+ createSetTimeVaryingAction(inTimeVarying: boolean): Action;
1004
+
1005
+ /**
1006
+ * Returned promise will be fullfilled with the start value (keyframe) of the component param
1007
+ */
1008
+ getStartValue(): Promise<Keyframe>;
1009
+
1010
+ /**
1011
+ * Get a list of tickTime for the keyframes of this component param
1012
+ */
1013
+ getKeyframeListAsTickTimes(): TickTime[];
1014
+
1015
+ /**
1016
+ * Get the Keyframe at the given tickTime postion
1017
+ *
1018
+ * @param time
1019
+ */
1020
+ getKeyframePtr(time?: TickTime): Keyframe;
1021
+
1022
+ /**
1023
+ * Returns true if the parameter value varies over time (for the duration of the item)
1024
+ */
1025
+ isTimeVarying(): boolean;
1026
+
1027
+ /**
1028
+ * Returns an action which sets the interpolation mode of keyframe at the given time
1029
+ *
1030
+ * @param inTime
1031
+ * @param InterpolationMode
1032
+ * @param UpdateUI
1033
+ */
1034
+ createSetInterpolationAtKeyframeAction(
1035
+ inTime: TickTime,
1036
+ InterpolationMode: number,
1037
+ UpdateUI?: boolean
1038
+ ): Action;
1039
+
1040
+ /**
1041
+ * Returns bool whether keyframes are supported for this component parameter
1042
+ */
1043
+ areKeyframesSupported(): Promise<boolean>;
1044
+
1045
+ /**
1046
+ * Returns the display name of the component param
1047
+ * @readonly
1048
+ */
1049
+ readonly displayName: string;
1050
+ };
1051
+
1052
+ export declare type CompoundAction = {
1053
+ /**
1054
+ * Add an action to the compound action
1055
+ *
1056
+ * @param action
1057
+ */
1058
+ addAction(action: Action): boolean;
1059
+
1060
+ /**
1061
+ * Is the compound action empty?
1062
+ * @readonly
1063
+ */
1064
+ readonly empty: boolean;
1065
+ };
1066
+
1067
+ export declare type EncoderManagerStatic = {
1068
+ /**
1069
+ * Get the Encoder Manager object.
1070
+ */
1071
+ getManager(): EncoderManager;
1072
+
1073
+ /**
1074
+ * Get the Export File Extension of Input Preset file
1075
+ *
1076
+ * @param sequence
1077
+ * @param presetFilePath
1078
+ */
1079
+ getExportFileExtension(sequence: Sequence, presetFilePath: string): Promise<string>;
1080
+
1081
+ /**
1082
+ * Export type used to queue an export job into the Adobe Media Encoder export queue
1083
+ * @readonly
1084
+ */
1085
+ readonly EXPORT_QUEUE_TO_AME: string;
1086
+
1087
+ /**
1088
+ * Export type used to queue an export job into the app export queue
1089
+ * @readonly
1090
+ */
1091
+ readonly EXPORT_QUEUE_TO_APP: string;
1092
+
1093
+ /**
1094
+ * Export type used to immediately exporting an object
1095
+ * @readonly
1096
+ */
1097
+ readonly EXPORT_IMMEDIATELY: string;
1098
+
1099
+ /**
1100
+ * Broadcast when AME is finished rendering
1101
+ * @readonly
1102
+ */
1103
+ readonly EVENT_RENDER_COMPLETE: string;
1104
+
1105
+ /**
1106
+ * Broadcast when AME gives back error message
1107
+ * @readonly
1108
+ */
1109
+ readonly EVENT_RENDER_ERROR: string;
1110
+
1111
+ /**
1112
+ * Broadcast when AME job is canceled
1113
+ * @readonly
1114
+ */
1115
+ readonly EVENT_RENDER_CANCEL: string;
1116
+
1117
+ /**
1118
+ * Broadcast when AME job is queued
1119
+ * @readonly
1120
+ */
1121
+ readonly EVENT_RENDER_QUEUE: string;
1122
+
1123
+ /**
1124
+ * Broadcast when AME job is rendering the job
1125
+ * @readonly
1126
+ */
1127
+ readonly EVENT_RENDER_PROGRESS: string;
1128
+ };
1129
+
1130
+ export declare type EncoderManager = {
1131
+ /**
1132
+ * Export a sequence. If no output file and preset is specified, the sequence will be exported with the applied export settings or standard export rules will be applied.
1133
+ *
1134
+ * @param sequence
1135
+ * @param exportType Constants.ExportType.IMMEDIATELY, Constants.ExportType.QUEUE_TO_AME etc..
1136
+ * @param outputFile
1137
+ * @param presetFile
1138
+ * @param exportFull
1139
+ */
1140
+ exportSequence(
1141
+ sequence: Sequence,
1142
+ exportType: Constants.ExportType,
1143
+ outputFile?: string,
1144
+ presetFile?: string,
1145
+ exportFull?: boolean
1146
+ ): Promise<boolean>;
1147
+
1148
+ /**
1149
+ * Encode input clipProjectItem in AME
1150
+ *
1151
+ * @param clipProjectItem
1152
+ * @param outputFile
1153
+ * @param presetFile
1154
+ * @param workArea
1155
+ * @param removeUponCompletion
1156
+ * @param startQueueImmediately
1157
+ */
1158
+ encodeProjectItem(
1159
+ clipProjectItem: ClipProjectItem,
1160
+ outputFile?: string,
1161
+ presetFile?: string,
1162
+ workArea?: number,
1163
+ removeUponCompletion?: boolean,
1164
+ startQueueImmediately?: boolean
1165
+ ): Promise<boolean>;
1166
+
1167
+ /**
1168
+ * Encode input media file in AME
1169
+ *
1170
+ * @param filePath
1171
+ * @param outputFile
1172
+ * @param presetFile
1173
+ * @param inPoint
1174
+ * @param outPoint
1175
+ * @param workArea
1176
+ * @param removeUponCompletion
1177
+ * @param startQueueImmediately
1178
+ */
1179
+ encodeFile(
1180
+ filePath: string,
1181
+ outputFile?: string,
1182
+ presetFile?: string,
1183
+ inPoint: TickTime,
1184
+ outPoint: TickTime,
1185
+ workArea?: number,
1186
+ removeUponCompletion?: boolean,
1187
+ startQueueImmediately?: boolean
1188
+ ): Promise<boolean>;
1189
+
1190
+ /**
1191
+ * Check if AME is installed.
1192
+ * @readonly
1193
+ */
1194
+ readonly isAMEInstalled: boolean;
1195
+ };
1196
+
1197
+ export declare type ExporterStatic = {
1198
+ /**
1199
+ * Exports from a sequence. Supported formats are bmp, dpx, gif, jpg, exr, png, tga and tif
1200
+ *
1201
+ * @param sequence
1202
+ * @param time
1203
+ * @param filename Filename to be exported , example 'C:/temp/exportedFrame.png'
1204
+ * @param filepath Directory to be exported, example 'C:/temp/'
1205
+ * @param width
1206
+ * @param height
1207
+ */
1208
+ exportSequenceFrame(
1209
+ sequence: Sequence,
1210
+ time: TickTime,
1211
+ filename: string,
1212
+ filepath: string,
1213
+ width: number,
1214
+ height: number
1215
+ ): Promise<boolean>;
1216
+ };
1217
+
1218
+ export declare type Exporter = {};
1219
+
1220
+ export declare type FolderItemStatic = {
1221
+ /**
1222
+ * Cast ProjectItem in to FolderItem
1223
+ *
1224
+ * @param projectItem
1225
+ */
1226
+ cast(projectItem: ProjectItem): FolderItem;
1227
+ };
1228
+
1229
+ export declare type FolderItem = {
1230
+ /**
1231
+ * Returns an action that lets users create a new bin.
1232
+ *
1233
+ * @param name
1234
+ * @param makeUnique
1235
+ */
1236
+ createBinAction(name: string, makeUnique: boolean): Action;
1237
+
1238
+ /**
1239
+ * Creates a smart bin with given name and returns the Folder object
1240
+ *
1241
+ * @param name
1242
+ * @param searchQuery
1243
+ */
1244
+ createSmartBinAction(name: string, searchQuery: string): Action;
1245
+
1246
+ /**
1247
+ * Rename the Bin and return true if it's successful
1248
+ *
1249
+ * @param name
1250
+ */
1251
+ createRenameBinAction(name: string): Action;
1252
+
1253
+ /**
1254
+ * Collection of child items of this folder.
1255
+ */
1256
+ getItems(): Promise<ProjectItem[]>;
1257
+
1258
+ /**
1259
+ * Creates an action that removes the given item from this folder.
1260
+ *
1261
+ * @param item
1262
+ */
1263
+ createRemoveItemAction(item: ProjectItem): Action;
1264
+
1265
+ /**
1266
+ * Creates an action that moves the given item to the provided folder item newParent.
1267
+ *
1268
+ * @param item
1269
+ * @param newParent
1270
+ */
1271
+ createMoveItemAction(item: ProjectItem, newParent: FolderItem): Action;
1272
+
1273
+ /**
1274
+ * Returns action that renames projectItem
1275
+ *
1276
+ * @param inName
1277
+ */
1278
+ createSetNameAction(inName: string): Action;
1279
+
1280
+ /**
1281
+ * Get color label index of projectItem
1282
+ */
1283
+ getColorLabelIndex(): Promise<number>;
1284
+
1285
+ /**
1286
+ * Create an action for set color label to projectItem by index
1287
+ *
1288
+ * @param inColorLabelIndex
1289
+ */
1290
+ createSetColorLabelAction(inColorLabelIndex: number): Action;
1291
+
1292
+ /**
1293
+ * Get the parent Project of this projectItem.
1294
+ */
1295
+ getProject(): Promise<Project>;
1296
+
1297
+ /**
1298
+ * Get the type of the Project Item.
1299
+ * @readonly
1300
+ */
1301
+ readonly type: number;
1302
+
1303
+ /**
1304
+ * The name of this project item.
1305
+ * @readonly
1306
+ */
1307
+ readonly name: string;
1308
+ };
1309
+
1310
+ export declare type FootageInterpretation = {
1311
+ /**
1312
+ * Get frame rate of footage
1313
+ */
1314
+ getFrameRate(): number;
1315
+
1316
+ /**
1317
+ * Set frame rate of footage
1318
+ *
1319
+ * @param frameRate
1320
+ */
1321
+ setFrameRate(frameRate: number): boolean;
1322
+
1323
+ /**
1324
+ * Get pixel aspect ratio of footage
1325
+ */
1326
+ getPixelAspectRatio(): number;
1327
+
1328
+ /**
1329
+ * Set pixel aspect ratio of footage
1330
+ *
1331
+ * @param pixelAspectRatio
1332
+ */
1333
+ setPixelAspectRatio(pixelAspectRatio: number): boolean;
1334
+
1335
+ /**
1336
+ * Get field type of footage
1337
+ */
1338
+ getFieldType(): number;
1339
+
1340
+ /**
1341
+ * Set field type of footage
1342
+ *
1343
+ * @param fieldType
1344
+ */
1345
+ setFieldType(fieldType: number): boolean;
1346
+
1347
+ /**
1348
+ * Get removePullDown property of footage
1349
+ */
1350
+ getRemovePullDown(): boolean;
1351
+
1352
+ /**
1353
+ * Set removePullDown property of footage
1354
+ *
1355
+ * @param removePulldown
1356
+ */
1357
+ setRemovePullDown(removePulldown: boolean): boolean;
1358
+
1359
+ /**
1360
+ * Get alpha usage type property of footage
1361
+ */
1362
+ getAlphaUsage(): number;
1363
+
1364
+ /**
1365
+ * Set alpha usage type property of footage
1366
+ *
1367
+ * @param alphaUsage
1368
+ */
1369
+ setAlphaUsage(alphaUsage: number): boolean;
1370
+
1371
+ /**
1372
+ * Get ignore alpha property of footage
1373
+ */
1374
+ getIgnoreAlpha(): boolean;
1375
+
1376
+ /**
1377
+ * Set ignore alpha property of footage
1378
+ *
1379
+ * @param ignoreAlpha
1380
+ */
1381
+ setIgnoreAlpha(ignoreAlpha: boolean): boolean;
1382
+
1383
+ /**
1384
+ * Get invert alpha property of footage
1385
+ */
1386
+ getInvertAlpha(): boolean;
1387
+
1388
+ /**
1389
+ * Set invert alpha property of footage
1390
+ *
1391
+ * @param invertAlpha
1392
+ */
1393
+ setInvertAlpha(invertAlpha: boolean): boolean;
1394
+
1395
+ /**
1396
+ * Get vr conform projection type of footage
1397
+ */
1398
+ getVrConform(): number;
1399
+
1400
+ /**
1401
+ * Set vr conform projection type of footage
1402
+ *
1403
+ * @param vrConform
1404
+ */
1405
+ setVrConform(vrConform: number): boolean;
1406
+
1407
+ /**
1408
+ * Get vr layout type of footage
1409
+ */
1410
+ getVrLayout(): number;
1411
+
1412
+ /**
1413
+ * Set vr layout type of footage
1414
+ *
1415
+ * @param vrLayOut
1416
+ */
1417
+ setVrLayout(vrLayOut: number): boolean;
1418
+
1419
+ /**
1420
+ * Get vr horizontal view of footage
1421
+ */
1422
+ getVrHorzView(): number;
1423
+
1424
+ /**
1425
+ * Set vr horizontal view of footage
1426
+ *
1427
+ * @param vrHorzView
1428
+ */
1429
+ setVrHorzView(vrHorzView: number): boolean;
1430
+
1431
+ /**
1432
+ * Get vr vertical view of footage
1433
+ */
1434
+ getVrVertView(): number;
1435
+
1436
+ /**
1437
+ * Set vr horizontal view of footage
1438
+ *
1439
+ * @param vrVertView
1440
+ */
1441
+ setVrVertView(vrVertView: number): boolean;
1442
+
1443
+ /**
1444
+ * Get input LUTID of footage
1445
+ */
1446
+ getInputLUTID(): string;
1447
+
1448
+ /**
1449
+ * Set input LUTID of footage
1450
+ *
1451
+ * @param inputLUTID
1452
+ */
1453
+ setInputLUTID(inputLUTID: string): boolean;
1454
+
1455
+ /**
1456
+ * alpha channel none
1457
+ * @readonly
1458
+ */
1459
+ readonly ALPHACHANNEL_NONE: number;
1460
+
1461
+ /**
1462
+ * alpha channel straight
1463
+ * @readonly
1464
+ */
1465
+ readonly ALPHACHANNEL_STRAIGHT: number;
1466
+
1467
+ /**
1468
+ * alpha channel premultiplied
1469
+ * @readonly
1470
+ */
1471
+ readonly ALPHACHANNEL_PREMULTIPLIED: number;
1472
+
1473
+ /**
1474
+ * alpha channel ignore
1475
+ * @readonly
1476
+ */
1477
+ readonly ALPHACHANNEL_IGNORE: number;
1478
+
1479
+ /**
1480
+ * default filed type invalid
1481
+ * @readonly
1482
+ */
1483
+ readonly FIELD_TYPE_DEFAULT: number;
1484
+
1485
+ /**
1486
+ * field type progressive
1487
+ * @readonly
1488
+ */
1489
+ readonly FIELD_TYPE_PROGRESSIVE: number;
1490
+
1491
+ /**
1492
+ * field type upperfirst
1493
+ * @readonly
1494
+ */
1495
+ readonly FIELD_TYPE_UPPERFIRST: number;
1496
+
1497
+ /**
1498
+ * field type lowerfirst
1499
+ * @readonly
1500
+ */
1501
+ readonly FIELD_TYPE_LOWERFIRST: number;
1502
+ };
1503
+
1504
+ export declare type FrameRateStatic = {
1505
+ /**
1506
+ * Create frame rate object with a value
1507
+ *
1508
+ * @param value
1509
+ */
1510
+ createWithValue(value: number): FrameRate;
1511
+ };
1512
+
1513
+ export declare type FrameRate = {
1514
+ /**
1515
+ * Constructs a new instance of the FrameRate class.
1516
+ * @constructor
1517
+ */
1518
+ new (): FrameRate;
1519
+ (): FrameRate;
1520
+
1521
+ /**
1522
+ * Returns true if the given FrameRate is equal to this FrameRate object
1523
+ *
1524
+ * @param frameRate
1525
+ */
1526
+ equals(frameRate: FrameRate): boolean;
1527
+
1528
+ /**
1529
+ * Read/Write property to get/set ticks per frame.
1530
+ */
1531
+ ticksPerFrame: number;
1532
+
1533
+ /**
1534
+ * Get the number of frames per second.
1535
+ * @readonly
1536
+ */
1537
+ readonly value: number;
1538
+ };
1539
+
1540
+ export declare type GuidStatic = {
1541
+ /**
1542
+ * Create a guid from a string
1543
+ *
1544
+ * @param stringValue
1545
+ */
1546
+ fromString(stringValue: string): Guid;
1547
+ };
1548
+
1549
+ export declare type Guid = {
1550
+ /**
1551
+ * Constructs a new instance of the Guid class.
1552
+ * @constructor
1553
+ */
1554
+ new (): Guid;
1555
+ (): Guid;
1556
+
1557
+ /**
1558
+ * Return string representation of the GUID
1559
+ */
1560
+ toString(): string;
1561
+ };
1562
+
1563
+ export declare type IngestSettings = {
1564
+ /**
1565
+ * Get whether or not ingest is enabled
1566
+ */
1567
+ getIsIngestEnabled(): Promise<boolean>;
1568
+
1569
+ /**
1570
+ * Set whether or not ingest is enabled
1571
+ *
1572
+ * @param enabled
1573
+ */
1574
+ setIngestEnabled(enabled: boolean): Promise<boolean>;
1575
+ };
1576
+
1577
+ export declare type KeyframeStatic = {
1578
+ /**
1579
+ * Linear interpolation mode
1580
+ * @readonly
1581
+ */
1582
+ readonly INTERPOLATION_MODE_LINEAR: number;
1583
+
1584
+ /**
1585
+ * Hold interpolation mode
1586
+ * @readonly
1587
+ */
1588
+ readonly INTERPOLATION_MODE_HOLD: number;
1589
+
1590
+ /**
1591
+ * Bezier interpolation mode
1592
+ * @readonly
1593
+ */
1594
+ readonly INTERPOLATION_MODE_BEZIER: number;
1595
+
1596
+ /**
1597
+ * Time interpolation mode
1598
+ * @readonly
1599
+ */
1600
+ readonly INTERPOLATION_MODE_TIME: number;
1601
+
1602
+ /**
1603
+ * Time transition start interpolation mode
1604
+ * @readonly
1605
+ */
1606
+ readonly INTERPOLATION_MODE_TIME_TRANSITION_START: number;
1607
+
1608
+ /**
1609
+ * Time transition end interpolation mode
1610
+ * @readonly
1611
+ */
1612
+ readonly INTERPOLATION_MODE_TIME_TRANSITION_END: number;
1613
+ };
1614
+
1615
+ export declare type Keyframe = {
1616
+ /**
1617
+ * Gets temporal interpolation mode of a keyframe
1618
+ */
1619
+ getTemporalInterpolationMode(): Promise<number>;
1620
+
1621
+ /**
1622
+ * Sets temporal interpolation mode of a keyframe
1623
+ *
1624
+ * @param temporalInterpolationMode
1625
+ */
1626
+ setTemporalInterpolationMode(temporalInterpolationMode: number): Promise<boolean>;
1627
+
1628
+ /**
1629
+ */
1630
+ value: { value: string | number | boolean | Color | PointF };
1631
+
1632
+ /**
1633
+ * Get/Set position of a keyframe
1634
+ */
1635
+ position: TickTime;
1636
+ };
1637
+
1638
+ export declare type MarkerStatic = {
1639
+ /**
1640
+ * Marker Type: Comment
1641
+ * @readonly
1642
+ */
1643
+ readonly MARKER_TYPE_COMMENT: string;
1644
+
1645
+ /**
1646
+ * Marker Type: Chapter
1647
+ * @readonly
1648
+ */
1649
+ readonly MARKER_TYPE_CHAPTER: string;
1650
+
1651
+ /**
1652
+ * Marker Type: FLVCuePoint
1653
+ * @readonly
1654
+ */
1655
+ readonly MARKER_TYPE_FLVCUEPOINT: string;
1656
+
1657
+ /**
1658
+ * Marker Type: WebLink
1659
+ * @readonly
1660
+ */
1661
+ readonly MARKER_TYPE_WEBLINK: string;
1662
+ };
1663
+
1664
+ export declare type Marker = {
1665
+ /**
1666
+ * Get color code of the marker.
1667
+ */
1668
+ getColor(): Color;
1669
+
1670
+ /**
1671
+ * Get color index of the marker.
1672
+ */
1673
+ getColorIndex(): number;
1674
+
1675
+ /**
1676
+ * Get comments of the marker.
1677
+ */
1678
+ getComments(): string;
1679
+
1680
+ /**
1681
+ * Get duration time of the marker.
1682
+ */
1683
+ getDuration(): TickTime;
1684
+
1685
+ /**
1686
+ * Get name of the marker.
1687
+ */
1688
+ getName(): string;
1689
+
1690
+ /**
1691
+ * Get url of the marker.
1692
+ */
1693
+ getUrl(): string;
1694
+
1695
+ /**
1696
+ * Get target of the marker. Used together with url for web targets.
1697
+ */
1698
+ getTarget(): string;
1699
+
1700
+ /**
1701
+ * Get type of the marker. e.g. Cue / Track / Subclip / Cart
1702
+ */
1703
+ getType(): string;
1704
+
1705
+ /**
1706
+ * Get start time of the marker.
1707
+ */
1708
+ getStart(): TickTime;
1709
+
1710
+ /**
1711
+ * Return an action to set the color of the marker by the color index
1712
+ *
1713
+ * @param colorIndex
1714
+ */
1715
+ createSetColorByIndexAction(colorIndex: number): Action;
1716
+
1717
+ /**
1718
+ * Return an action to set the name of the marker.
1719
+ *
1720
+ * @param name
1721
+ */
1722
+ createSetNameAction(name: string): Action;
1723
+
1724
+ /**
1725
+ * Return an action to set the duration of the marker.
1726
+ *
1727
+ * @param tickTime
1728
+ */
1729
+ createSetDurationAction(tickTime: TickTime): Action;
1730
+
1731
+ /**
1732
+ * Return an action to set the type of the marker.
1733
+ *
1734
+ * @param markerType This values can be Scale (0), AnchorToInPoint (1) or AnchorToOutPoint (2)
1735
+ */
1736
+ createSetTypeAction(markerType: string): Action;
1737
+
1738
+ /**
1739
+ * Return an action to set the comments of the marker.
1740
+ *
1741
+ * @param comments
1742
+ */
1743
+ createSetCommentsAction(comments: string): Action;
1744
+ };
1745
+
1746
+ export declare type MarkersStatic = {
1747
+ /**
1748
+ * Returns the Markers object for Sequence Or ProjectItem
1749
+ *
1750
+ * @param markerOwnerObject
1751
+ */
1752
+ getMarkers(markerOwnerObject: Sequence | ClipProjectItem): Promise<Markers>;
1753
+ };
1754
+
1755
+ export declare type Markers = {
1756
+ /**
1757
+ * Get all markers
1758
+ *
1759
+ * @param filters Marker Type Filter (Optional)
1760
+ */
1761
+ getMarkers(filters?: string[]): Marker[];
1762
+
1763
+ /**
1764
+ * Remove the given marker
1765
+ *
1766
+ * @param marker
1767
+ */
1768
+ createRemoveMarkerAction(marker: Marker): Action;
1769
+
1770
+ /**
1771
+ * Move the given marker at new time value
1772
+ *
1773
+ * @param marker
1774
+ * @param tickTime
1775
+ */
1776
+ createMoveMarkerAction(marker: Marker, tickTime: TickTime): Action;
1777
+
1778
+ /**
1779
+ * Add a new marker
1780
+ *
1781
+ * @param Name
1782
+ * @param markerType
1783
+ * @param startTime
1784
+ * @param duration
1785
+ * @param comments
1786
+ */
1787
+ createAddMarkerAction(
1788
+ Name: string,
1789
+ markerType?: string,
1790
+ startTime?: TickTime,
1791
+ duration?: TickTime,
1792
+ comments?: string
1793
+ ): Action;
1794
+ };
1795
+
1796
+ export declare type Media = {
1797
+ /**
1798
+ * Returns action that set start of media
1799
+ *
1800
+ * @param time
1801
+ */
1802
+ createSetStartAction(time: TickTime): Action;
1803
+
1804
+ /**
1805
+ * Get the media start time
1806
+ * @readonly
1807
+ */
1808
+ readonly start: TickTime;
1809
+
1810
+ /**
1811
+ * Get the media duration
1812
+ * @readonly
1813
+ */
1814
+ readonly duration: TickTime;
1815
+ };
1816
+
1817
+ export declare type MetadataStatic = {
1818
+ /**
1819
+ * Get project metadata
1820
+ *
1821
+ * @param projectItem
1822
+ */
1823
+ getProjectMetadata(projectItem: ProjectItem): Promise<string>;
1824
+
1825
+ /**
1826
+ * Get project XMP metadata
1827
+ *
1828
+ * @param projectItem
1829
+ */
1830
+ getXMPMetadata(projectItem: ProjectItem): Promise<string>;
1831
+
1832
+ /**
1833
+ * Get set project metadata action
1834
+ *
1835
+ * @param projectItem
1836
+ * @param metadata
1837
+ * @param updatedFields
1838
+ */
1839
+ createSetProjectMetadataAction(
1840
+ projectItem: ProjectItem,
1841
+ metadata: string,
1842
+ updatedFields: string[]
1843
+ ): Action;
1844
+
1845
+ /**
1846
+ * Get set project XMP metadata action
1847
+ *
1848
+ * @param projectItem
1849
+ * @param metadata
1850
+ */
1851
+ createSetXMPMetadataAction(projectItem: ProjectItem, metadata: string): Action;
1852
+
1853
+ /**
1854
+ * Add name and label property to project metadata schema
1855
+ *
1856
+ * @param name
1857
+ * @param label
1858
+ * @param type
1859
+ */
1860
+ addPropertyToProjectMetadataSchema(name: string, label: string, type: number): Promise<boolean>;
1861
+
1862
+ /**
1863
+ * Get project column metadata from project item
1864
+ *
1865
+ * @param projectItem
1866
+ */
1867
+ getProjectColumnsMetadata(projectItem: ProjectItem): Promise<string>;
1868
+
1869
+ /**
1870
+ * Get project panel metadata
1871
+ */
1872
+ getProjectPanelMetadata(): Promise<string>;
1873
+
1874
+ /**
1875
+ * Set project panel metadata
1876
+ *
1877
+ * @param metadata
1878
+ */
1879
+ setProjectPanelMetadata(metadata: string): Promise<boolean>;
1880
+
1881
+ /**
1882
+ * Metadata Type: INTEGER
1883
+ * @readonly
1884
+ */
1885
+ readonly METADATA_TYPE_INTEGER: number;
1886
+
1887
+ /**
1888
+ * Metadata Type: REAL
1889
+ * @readonly
1890
+ */
1891
+ readonly METADATA_TYPE_REAL: number;
1892
+
1893
+ /**
1894
+ * Metadata Type: TEXT
1895
+ * @readonly
1896
+ */
1897
+ readonly METADATA_TYPE_TEXT: number;
1898
+
1899
+ /**
1900
+ * Metadata Type: BOOLEAN
1901
+ * @readonly
1902
+ */
1903
+ readonly METADATA_TYPE_BOOLEAN: number;
1904
+ };
1905
+
1906
+ export declare type Metadata = {};
1907
+
1908
+ export declare type OpenProjectOptions = {
1909
+ /**
1910
+ * Constructs a new instance of the OpenProjectOptions class.
1911
+ * @constructor
1912
+ */
1913
+ new (): OpenProjectOptions;
1914
+ (): OpenProjectOptions;
1915
+
1916
+ /**
1917
+ * Set whether to show the convert project dialog on project open/close
1918
+ *
1919
+ * @param showConvertProjectDialog
1920
+ */
1921
+ setShowConvertProjectDialog(showConvertProjectDialog: boolean): OpenProjectOptions;
1922
+
1923
+ /**
1924
+ * Set whether to show the locate file dialog on project open/close
1925
+ *
1926
+ * @param showLocateFileDialog
1927
+ */
1928
+ setShowLocateFileDialog(showLocateFileDialog: boolean): OpenProjectOptions;
1929
+
1930
+ /**
1931
+ * Set whether to show the warning file dialog on project open/close
1932
+ *
1933
+ * @param showConvertProjectDialog
1934
+ */
1935
+ setShowWarningDialog(showConvertProjectDialog: boolean): OpenProjectOptions;
1936
+
1937
+ /**
1938
+ * Set whether to add to MRU list after project changes
1939
+ *
1940
+ * @param addToMRUList
1941
+ */
1942
+ setAddToMRUList(addToMRUList: boolean): OpenProjectOptions;
1943
+
1944
+ /**
1945
+ * Get whether the convert project dialog is shown on project open/close
1946
+ * @readonly
1947
+ */
1948
+ readonly showConvertProjectDialog: boolean;
1949
+
1950
+ /**
1951
+ * Get whether locate file dialog is shown on project open/close
1952
+ * @readonly
1953
+ */
1954
+ readonly showLocateFileDialog: boolean;
1955
+
1956
+ /**
1957
+ * Get whether the warning file dialog is shown on project open/close
1958
+ * @readonly
1959
+ */
1960
+ readonly showWarningDialog: boolean;
1961
+
1962
+ /**
1963
+ * Get whether to add project changes to MRU list
1964
+ * @readonly
1965
+ */
1966
+ readonly addToMRUList: boolean;
1967
+ };
1968
+
1969
+ export declare type OperationCompleteEventStatic = {
1970
+ /**
1971
+ * Represents the state when an operation completes successfully.
1972
+ * @readonly
1973
+ */
1974
+ readonly OPERATION_STATE_SUCCESS: number;
1975
+
1976
+ /**
1977
+ * Represents the state when an operation is cancelled.
1978
+ * @readonly
1979
+ */
1980
+ readonly OPERATION_STATE_CANCELLED: number;
1981
+
1982
+ /**
1983
+ * Represents the state when an operation is failed.
1984
+ * @readonly
1985
+ */
1986
+ readonly OPERATION_STATE_FAILED: number;
1987
+
1988
+ /**
1989
+ * Event occurs when a media import operation is complete.
1990
+ * @readonly
1991
+ */
1992
+ readonly EVENT_IMPORT_MEDIA_COMPLETE: string;
1993
+
1994
+ /**
1995
+ * Event occurs when a media export operation is complete.
1996
+ * @readonly
1997
+ */
1998
+ readonly EVENT_EXPORT_MEDIA_COMPLETE: string;
1999
+
2000
+ /**
2001
+ * Event occurs when an effect is dropped on a trackitem
2002
+ * @readonly
2003
+ */
2004
+ readonly EVENT_EFFECT_DROP_COMPLETE: string;
2005
+
2006
+ /**
2007
+ * Event occurs when an effect is drag over a trackitem
2008
+ * @readonly
2009
+ */
2010
+ readonly EVENT_EFFECT_DRAG_OVER: string;
2011
+
2012
+ /**
2013
+ * Event occurs when a clip reached its maximum extend limit.
2014
+ * @readonly
2015
+ */
2016
+ readonly EVENT_CLIP_EXTEND_REACHED: string;
2017
+
2018
+ /**
2019
+ * Event occurs when a generative extend operation is complete.
2020
+ * @readonly
2021
+ */
2022
+ readonly EVENT_GENERATIVE_EXTEND_COMPLETE: string;
2023
+ };
2024
+
2025
+ export declare type OperationCompleteEvent = {
2026
+ /**
2027
+ * Indicates the outcome of a completed operation: Success, Cancelled, or Failed.
2028
+ * @readonly
2029
+ */
2030
+ readonly state: number;
2031
+ };
2032
+
2033
+ export declare type PRProductionStatic = {
2034
+ /**
2035
+ * Get an instance of the currently active production.
2036
+ */
2037
+ getActiveProduction(): PRProduction;
2038
+ };
2039
+
2040
+ export declare type PRProduction = {
2041
+ /**
2042
+ * Get the scratch disk settings instance for this production.
2043
+ */
2044
+ getScratchDiskSettings(): Promise<ScratchDiskSettings>;
2045
+ };
2046
+
2047
+ export declare type PointF = {
2048
+ /**
2049
+ * Constructs a new instance of the PointF class.
2050
+ * @constructor
2051
+ *
2052
+ * @param [x]
2053
+ * @param [y]
2054
+ */
2055
+ new (x?: number, y?: number): PointF;
2056
+ (x?: number, y?: number): PointF;
2057
+
2058
+ /**
2059
+ * Get the distance from one point to another point
2060
+ *
2061
+ * @param point
2062
+ */
2063
+ distanceTo(point: PointF): number;
2064
+
2065
+ /**
2066
+ * Get/Set the x value of a point
2067
+ */
2068
+ x: number;
2069
+
2070
+ /**
2071
+ * Get/Set the y value of a point
2072
+ */
2073
+ y: number;
2074
+ };
2075
+
2076
+ export declare type PointKeyframe = {
2077
+ /**
2078
+ */
2079
+ value: { value: PointF };
2080
+
2081
+ /**
2082
+ * Get/Set position of a keyframe
2083
+ */
2084
+ position: TickTime;
2085
+ };
2086
+
2087
+ export declare type ProjectStatic = {
2088
+ /**
2089
+ * Create a new project
2090
+ *
2091
+ * @param path
2092
+ */
2093
+ createProject(path: string): Promise<Project>;
2094
+
2095
+ /**
2096
+ * Returns true if the file at the given path is openable as a Premiere project
2097
+ *
2098
+ * @param projectPath
2099
+ */
2100
+ isProject(projectPath: string): boolean;
2101
+
2102
+ /**
2103
+ * Open a project
2104
+ *
2105
+ * @param path
2106
+ * @param openProjectOptions
2107
+ */
2108
+ open(path: string, openProjectOptions?: OpenProjectOptions): Promise<Project>;
2109
+
2110
+ /**
2111
+ * Currently active project.
2112
+ */
2113
+ getActiveProject(): Promise<Project>;
2114
+
2115
+ /**
2116
+ * Get project referenced by given UID
2117
+ *
2118
+ * @param projectGuid
2119
+ */
2120
+ getProject(projectGuid: Guid): Project;
2121
+ };
2122
+
2123
+ export declare type Project = {
2124
+ /**
2125
+ * Get the active sequence of the project
2126
+ */
2127
+ getActiveSequence(): Promise<Sequence>;
2128
+
2129
+ /**
2130
+ * Set the active sequence of the project
2131
+ *
2132
+ * @param sequence
2133
+ */
2134
+ setActiveSequence(sequence: Sequence): Promise<boolean>;
2135
+
2136
+ /**
2137
+ * Create a new sequence with the default preset path - Parameter presetPath is deprecated, instead use createSequenceWithPresetPath()
2138
+ *
2139
+ * @param name
2140
+ * @param presetPath
2141
+ */
2142
+ createSequence(name: string, presetPath?: string): Promise<Sequence>;
2143
+
2144
+ /**
2145
+ * Create a new sequence with a given name and medias
2146
+ *
2147
+ * @param name
2148
+ * @param clipProjectItems
2149
+ * @param targetBin
2150
+ */
2151
+ createSequenceFromMedia(
2152
+ name: string,
2153
+ clipProjectItems?: ClipProjectItem[],
2154
+ targetBin?: ProjectItem
2155
+ ): Promise<Sequence>;
2156
+
2157
+ /**
2158
+ * Get project color settings object
2159
+ */
2160
+ getColorSettings(): Promise<ProjectColorSettings>;
2161
+
2162
+ /**
2163
+ * Delete a given sequence from the project
2164
+ *
2165
+ * @param sequence
2166
+ */
2167
+ deleteSequence(sequence: Sequence): Promise<boolean>;
2168
+
2169
+ /**
2170
+ * Get current insertion bin
2171
+ */
2172
+ getInsertionBin(): Promise<ProjectItem>;
2173
+
2174
+ /**
2175
+ * Open a sequence and return true if successful.
2176
+ *
2177
+ * @param sequence
2178
+ */
2179
+ openSequence(sequence: Sequence): Promise<boolean>;
2180
+
2181
+ /**
2182
+ * Close a sequence and return true if successful.
2183
+ *
2184
+ * @param sequence
2185
+ */
2186
+ closeSequence(sequence: Sequence): Promise<boolean>;
2187
+
2188
+ /**
2189
+ *
2190
+ * @param projectPath
2191
+ * @param sequenceIds
2192
+ */
2193
+ importSequences(projectPath: string, sequenceIds?: Guid[]): Promise<boolean>;
2194
+
2195
+ /**
2196
+ *
2197
+ * @param aepPath
2198
+ * @param compNames
2199
+ * @param TargetBin
2200
+ */
2201
+ importAEComps(aepPath: string, compNames: string[], TargetBin?: ProjectItem): Promise<boolean>;
2202
+
2203
+ /**
2204
+ *
2205
+ * @param aepPath
2206
+ * @param TargetBin
2207
+ */
2208
+ importAllAEComps(aepPath: string, TargetBin?: ProjectItem): Promise<boolean>;
2209
+
2210
+ /**
2211
+ * Import files in root/target bin of the project
2212
+ *
2213
+ * @param filePaths
2214
+ * @param suppressUI
2215
+ * @param targetBin
2216
+ * @param asNumberedStills
2217
+ */
2218
+ importFiles(
2219
+ filePaths: string[],
2220
+ suppressUI?: boolean,
2221
+ targetBin?: ProjectItem,
2222
+ asNumberedStills?: boolean
2223
+ ): Promise<boolean>;
2224
+
2225
+ /**
2226
+ * Close a project
2227
+ *
2228
+ * @param closeProjectOptions
2229
+ */
2230
+ close(closeProjectOptions?: CloseProjectOptions): Promise<boolean>;
2231
+
2232
+ /**
2233
+ * Save the project
2234
+ */
2235
+ save(): Promise<boolean>;
2236
+
2237
+ /**
2238
+ * Save the project at the provided path
2239
+ *
2240
+ * @param path
2241
+ */
2242
+ saveAs(path: string): Promise<boolean>;
2243
+
2244
+ /**
2245
+ * Get sequence by id from the project
2246
+ *
2247
+ * @param guid
2248
+ */
2249
+ getSequence(guid: Guid): Sequence;
2250
+
2251
+ /**
2252
+ * Get an array of all sequences in this project.
2253
+ */
2254
+ getSequences(): Promise<Sequence[]>;
2255
+
2256
+ /**
2257
+ * The root item of the project which contains all items of the project on the lowest level.
2258
+ */
2259
+ getRootItem(): Promise<FolderItem>;
2260
+
2261
+ /**
2262
+ * Pause growing of files instead swap the files
2263
+ *
2264
+ * @param pause
2265
+ */
2266
+ pauseGrowing(pause: boolean): Promise<boolean>;
2267
+
2268
+ /**
2269
+ * Execute undoable transaction by passing compound action
2270
+ *
2271
+ * @param callback
2272
+ * @param undoString?
2273
+ */
2274
+ executeTransaction(
2275
+ callback: (compoundAction: CompoundAction) => void,
2276
+ undoString?: string
2277
+ ): boolean;
2278
+
2279
+ /**
2280
+ * Get a read/upgrade locked access to Project, project state will not change during the execution of callback function. Can call executeTransaction while having locked access.
2281
+ *
2282
+ * @param callback
2283
+ */
2284
+ lockedAccess(callback: () => void): void;
2285
+
2286
+ /**
2287
+ * The unique identifier of the project.
2288
+ * @readonly
2289
+ */
2290
+ readonly guid: Guid;
2291
+
2292
+ /**
2293
+ * The project name.
2294
+ * @readonly
2295
+ */
2296
+ readonly name: string;
2297
+
2298
+ /**
2299
+ * The absolute file path to the project file.
2300
+ * @readonly
2301
+ */
2302
+ readonly path: string;
2303
+ };
2304
+
2305
+ export declare type ProjectClosedEventStatic = {
2306
+ /**
2307
+ * Event occurs when project was closed.
2308
+ * @readonly
2309
+ */
2310
+ readonly EVENT_CLOSED: string;
2311
+ };
2312
+
2313
+ export declare type ProjectClosedEvent = {
2314
+ /**
2315
+ * The project name.
2316
+ * @readonly
2317
+ */
2318
+ readonly name: string;
2319
+
2320
+ /**
2321
+ * The absolute file path to the project file.
2322
+ * @readonly
2323
+ */
2324
+ readonly path: string;
2325
+
2326
+ /**
2327
+ * The unique identifier of the project.
2328
+ * @readonly
2329
+ */
2330
+ readonly id: string;
2331
+ };
2332
+
2333
+ export declare type ProjectColorSettings = {
2334
+ /**
2335
+ * Get all the graphics white luminance as array of values
2336
+ */
2337
+ getSupportedGraphicsWhiteLuminances(): Promise<number[]>;
2338
+
2339
+ /**
2340
+ * Get the graphics white luminance value
2341
+ */
2342
+ getGraphicsWhiteLuminance(): Promise<number>;
2343
+ };
2344
+
2345
+ export declare type ProjectConverterStatic = {
2346
+ /**
2347
+ * Export a sequence as Final Cut Pro XML to the specified output file path.
2348
+ *
2349
+ * @param sequence
2350
+ * @param outputFilePath
2351
+ * @param suppressUI
2352
+ */
2353
+ exportAsFinalCutProXML(
2354
+ sequence: Sequence,
2355
+ outputFilePath: string,
2356
+ suppressUI?: boolean
2357
+ ): Promise<boolean>;
2358
+
2359
+ /**
2360
+ * Export a sequence as OpenTimelineIO to the specified output file path.
2361
+ *
2362
+ * @param sequence
2363
+ * @param outputFilePath
2364
+ * @param suppressUI
2365
+ */
2366
+ exportAsOpenTimelineIO(
2367
+ sequence: Sequence,
2368
+ outputFilePath: string,
2369
+ suppressUI?: boolean
2370
+ ): Promise<boolean>;
2371
+
2372
+ /**
2373
+ * Import a Final Cut Pro XML file into the active project.
2374
+ *
2375
+ * @param importPath
2376
+ * @param suppressUI
2377
+ */
2378
+ importFromFinalCutProXML(importPath: string, suppressUI?: boolean): Promise<boolean>;
2379
+
2380
+ /**
2381
+ * Import an OpenTimelineIO file into the active project.
2382
+ *
2383
+ * @param importPath
2384
+ * @param suppressUI
2385
+ */
2386
+ importFromOpenTimelineIO(importPath: string, suppressUI?: boolean): Promise<boolean>;
2387
+ };
2388
+
2389
+ export declare type ProjectConverter = {};
2390
+
2391
+ export declare type ProjectEventStatic = {
2392
+ /**
2393
+ * Event occurs when project was opened.
2394
+ * @readonly
2395
+ */
2396
+ readonly EVENT_OPENED: string;
2397
+
2398
+ /**
2399
+ * Event occurs when the active project has changed
2400
+ * @readonly
2401
+ */
2402
+ readonly EVENT_ACTIVATED: string;
2403
+
2404
+ /**
2405
+ * Event occurs when the project dirty state changed.
2406
+ * @readonly
2407
+ */
2408
+ readonly EVENT_DIRTY: string;
2409
+ };
2410
+
2411
+ export declare type ProjectEvent = {
2412
+ /**
2413
+ * The project name.
2414
+ * @readonly
2415
+ */
2416
+ readonly name: string;
2417
+
2418
+ /**
2419
+ * The absolute file path to the project file.
2420
+ * @readonly
2421
+ */
2422
+ readonly path: string;
2423
+
2424
+ /**
2425
+ * The unique identifier of the project.
2426
+ * @readonly
2427
+ */
2428
+ readonly id: string;
2429
+
2430
+ /**
2431
+ * The project object.
2432
+ * @readonly
2433
+ */
2434
+ readonly project: Project;
2435
+ };
2436
+
2437
+ export declare type ProjectItemStatic = {
2438
+ /**
2439
+ * Cast FolderItem or ClipProjectItem in to ProjectItem
2440
+ *
2441
+ * @param item
2442
+ */
2443
+ cast(item: FolderItem | ClipProjectItem): ProjectItem;
2444
+
2445
+ /**
2446
+ * Project item type for clips.
2447
+ * @readonly
2448
+ */
2449
+ readonly TYPE_CLIP: number;
2450
+
2451
+ /**
2452
+ * Project item type for bins/folders.
2453
+ * @readonly
2454
+ */
2455
+ readonly TYPE_BIN: number;
2456
+
2457
+ /**
2458
+ * Project item type for the root container.
2459
+ * @readonly
2460
+ */
2461
+ readonly TYPE_ROOT: number;
2462
+
2463
+ /**
2464
+ * Project item type for generic files.
2465
+ * @readonly
2466
+ */
2467
+ readonly TYPE_FILE: number;
2468
+
2469
+ /**
2470
+ * Project item type for styles.
2471
+ * @readonly
2472
+ */
2473
+ readonly TYPE_STYLE: number;
2474
+
2475
+ /**
2476
+ * Project item type for compound clips.
2477
+ * @readonly
2478
+ */
2479
+ readonly TYPE_COMPOUND: number;
2480
+ };
2481
+
2482
+ export declare type ProjectItem = {
2483
+ /**
2484
+ * Returns action that renames projectItem
2485
+ *
2486
+ * @param inName
2487
+ */
2488
+ createSetNameAction(inName: string): Action;
2489
+
2490
+ /**
2491
+ * Get color label index of projectItem
2492
+ */
2493
+ getColorLabelIndex(): Promise<number>;
2494
+
2495
+ /**
2496
+ * Create an action for set color label to projectItem by index
2497
+ *
2498
+ * @param inColorLabelIndex
2499
+ */
2500
+ createSetColorLabelAction(inColorLabelIndex: number): Action;
2501
+
2502
+ /**
2503
+ * Get the parent Project of this projectItem.
2504
+ */
2505
+ getProject(): Promise<Project>;
2506
+
2507
+ /**
2508
+ * Get id of projectItem
2509
+ */
2510
+ getId(): string;
2511
+
2512
+ /**
2513
+ * Get parent FolderItem of projectItem
2514
+ */
2515
+ getParentBin(): FolderItem;
2516
+
2517
+ /**
2518
+ * Get the type of the Project Item.
2519
+ * @readonly
2520
+ */
2521
+ readonly type: number;
2522
+
2523
+ /**
2524
+ * The name of this project item.
2525
+ * @readonly
2526
+ */
2527
+ readonly name: string;
2528
+ };
2529
+
2530
+ export declare type ProjectItemSelection = {
2531
+ /**
2532
+ * Get the project items that is represented by this selection.
2533
+ */
2534
+ getItems(): Promise<ProjectItem[]>;
2535
+ };
2536
+
2537
+ export declare type ProjectSettingsStatic = {
2538
+ /**
2539
+ * Returns an action which sets ScratchDiskSetting
2540
+ *
2541
+ * @param project
2542
+ * @param scratchDiskSettings
2543
+ */
2544
+ createSetScratchDiskSettingsAction(
2545
+ project: Project,
2546
+ scratchDiskSettings: ScratchDiskSettings
2547
+ ): Action;
2548
+
2549
+ /**
2550
+ * Returns project ScratchDiskSettings
2551
+ *
2552
+ * @param project
2553
+ */
2554
+ getScratchDiskSettings(project: Project): Promise<ScratchDiskSettings>;
2555
+
2556
+ /**
2557
+ * Returns project ingest settings
2558
+ *
2559
+ * @param project
2560
+ */
2561
+ getIngestSettings(project: Project): Promise<IngestSettings>;
2562
+
2563
+ /**
2564
+ * Returns an action which sets IngestSettings
2565
+ *
2566
+ * @param project
2567
+ * @param ingestSettings
2568
+ */
2569
+ createSetIngestSettingsAction(project: Project, ingestSettings: IngestSettings): Action;
2570
+ };
2571
+
2572
+ export declare type ProjectSettings = {};
2573
+
2574
+ export declare type ProjectUtilsStatic = {
2575
+ /**
2576
+ * Get array of selected project items in project view
2577
+ *
2578
+ * @param project
2579
+ */
2580
+ getSelection(project: Project): Promise<ProjectItemSelection>;
2581
+
2582
+ /**
2583
+ * Get array of project view ids
2584
+ */
2585
+ getProjectViewIds(): Promise<Guid[]>;
2586
+
2587
+ /**
2588
+ * Get project based on input view guid
2589
+ *
2590
+ * @param guid
2591
+ */
2592
+ getProjectFromViewId(guid: Guid): Promise<Project>;
2593
+
2594
+ /**
2595
+ * Get array of selected projectItem based on input view guid
2596
+ *
2597
+ * @param guid
2598
+ */
2599
+ getSelectionFromViewId(guid: Guid): Promise<ProjectItemSelection>;
2600
+ };
2601
+
2602
+ export declare type ProjectUtils = {};
2603
+
2604
+ export declare type PropertiesStatic = {
2605
+ /**
2606
+ * Return Property Owner Object
2607
+ *
2608
+ * @param propertyOwnerObject This can also be object instance of Project, Sequence etc..
2609
+ */
2610
+ getProperties(propertyOwnerObject: Project | Sequence): Promise<Properties>;
2611
+
2612
+ /**
2613
+ * Property is persistent in backend and shared across cloud project.
2614
+ * @readonly
2615
+ */
2616
+ readonly PROPERTY_PERSISTENT: number;
2617
+
2618
+ /**
2619
+ * Property is not persisted and will be cleared when the project closes.
2620
+ * @readonly
2621
+ */
2622
+ readonly PROPERTY_NON_PERSISTENT: number;
2623
+ };
2624
+
2625
+ export declare type Properties = {
2626
+ /**
2627
+ * Get named value as integer number
2628
+ *
2629
+ * @param name
2630
+ */
2631
+ getValueAsInt(name: string): number;
2632
+
2633
+ /**
2634
+ * Get named value as float number
2635
+ *
2636
+ * @param name
2637
+ */
2638
+ getValueAsFloat(name: string): number;
2639
+
2640
+ /**
2641
+ * Get named value as boolean
2642
+ *
2643
+ * @param name
2644
+ */
2645
+ getValueAsBool(name: string): boolean;
2646
+
2647
+ /**
2648
+ * Get named value in native string form
2649
+ *
2650
+ * @param name
2651
+ */
2652
+ getValue(name: string): string;
2653
+
2654
+ /**
2655
+ * Create an action to set a named value through scripting. The parameters are <name, value (number, boolean or string), persistence flag>. This method can fail if e.g. the underlying properties object does not support action based setting of properties.
2656
+ *
2657
+ * @param name property name
2658
+ * @param value Value to set for the property key
2659
+ * @param persistenceFlag Indicates whether the property should be persisted or not
2660
+ */
2661
+ createSetValueAction(
2662
+ name: string,
2663
+ value: boolean | string | number,
2664
+ persistenceFlag: Constants.PropertyType
2665
+ ): Action;
2666
+
2667
+ /**
2668
+ * Check if a named value exists under this name.
2669
+ *
2670
+ * @param name
2671
+ */
2672
+ hasValue(name: string): boolean;
2673
+
2674
+ /**
2675
+ * Create an action to clear the value with the given name. This method can fail if e.g. the underlying properties object does not support action based setting of properties.
2676
+ *
2677
+ * @param name
2678
+ */
2679
+ createClearValueAction(name: string): Action;
2680
+ };
2681
+
2682
+ export declare type RectF = {
2683
+ /**
2684
+ * Constructs a new instance of the RectF class.
2685
+ * @constructor
2686
+ */
2687
+ new (): RectF;
2688
+ (): RectF;
2689
+
2690
+ /**
2691
+ * Get/Set the width of a rect
2692
+ */
2693
+ width: number;
2694
+
2695
+ /**
2696
+ * Get/Set the height of a rect
2697
+ */
2698
+ height: number;
2699
+ };
2700
+
2701
+ export declare type ScratchDiskSettingsStatic = {
2702
+ /**
2703
+ * Folder Type: CAPTURED
2704
+ * @readonly
2705
+ */
2706
+ readonly FOLDERTYPE_CAPTURE: string;
2707
+
2708
+ /**
2709
+ * Folder Type: VIDEOPREVIEW
2710
+ * @readonly
2711
+ */
2712
+ readonly FOLDERTYPE_VIDEO_PREVIEW: string;
2713
+
2714
+ /**
2715
+ * Folder Type: AUDIOPREVIEW
2716
+ * @readonly
2717
+ */
2718
+ readonly FOLDERTYPE_AUDIO_PREVIEW: string;
2719
+
2720
+ /**
2721
+ * Folder Type: AUTOSAVE
2722
+ * @readonly
2723
+ */
2724
+ readonly FOLDERTYPE_AUTO_SAVE: string;
2725
+
2726
+ /**
2727
+ * Folder Type: CCLLIBRARIES
2728
+ * @readonly
2729
+ */
2730
+ readonly FOLDERTYPE_CCL_LIBRARIES: string;
2731
+
2732
+ /**
2733
+ * Folder Type: CAPSULEMEDIA
2734
+ * @readonly
2735
+ */
2736
+ readonly FOLDERTYPE_CAPSULE_MEDIA: string;
2737
+
2738
+ /**
2739
+ * Folder: SAMEASPROJECT
2740
+ * @readonly
2741
+ */
2742
+ readonly FOLDER_SAME_AS_PROJECT: string;
2743
+
2744
+ /**
2745
+ * Folder: MYDOCUMNETS
2746
+ * @readonly
2747
+ */
2748
+ readonly FOLDER_MY_DOCUMNETS: string;
2749
+ };
2750
+
2751
+ export declare type ScratchDiskSettings = {
2752
+ /**
2753
+ * Sets project ScratchDisk Path
2754
+ *
2755
+ * @param ScratchDiskType
2756
+ * @param ScratchDiskValue
2757
+ */
2758
+ setScratchDiskPath(
2759
+ ScratchDiskType: Constants.ScratchDiskFolderType,
2760
+ ScratchDiskValue: Constants.ScratchDiskFolder
2761
+ ): boolean;
2762
+
2763
+ /**
2764
+ * Gets the scratchDisk location for specific disktype - may return symbolic paths for reserved types like 'MyDocuments'
2765
+ *
2766
+ * @param ScratchDiskType
2767
+ */
2768
+ getScratchDiskPath(ScratchDiskType: Constants.ScratchDiskFolderType): string;
2769
+ };
2770
+
2771
+ export declare type SequenceStatic = {};
2772
+
2773
+ export declare type Sequence = {
2774
+ /**
2775
+ * Get video time display format of this sequence
2776
+ */
2777
+ getSequenceVideoTimeDisplayFormat(): Promise<TimeDisplay>;
2778
+
2779
+ /**
2780
+ * Get audio time display format of this sequence
2781
+ */
2782
+ getSequenceAudioTimeDisplayFormat(): Promise<TimeDisplay>;
2783
+
2784
+ /**
2785
+ * Get the player's current position
2786
+ */
2787
+ getPlayerPosition(): Promise<TickTime>;
2788
+
2789
+ /**
2790
+ * Set the player's current position
2791
+ *
2792
+ * @param positionTime
2793
+ */
2794
+ setPlayerPosition(positionTime?: TickTime): Promise<boolean>;
2795
+
2796
+ /**
2797
+ * Clears TrackItem Selection
2798
+ */
2799
+ clearSelection(): Promise<boolean>;
2800
+
2801
+ /**
2802
+ * Updates sequence selection using the given track item selection.
2803
+ *
2804
+ * @param trackItemSelection
2805
+ */
2806
+ setSelection(trackItemSelection: TrackItemSelection): Promise<boolean>;
2807
+
2808
+ /**
2809
+ * Get video track count from this sequence
2810
+ */
2811
+ getVideoTrackCount(): Promise<number>;
2812
+
2813
+ /**
2814
+ * Get audio track count from this sequence
2815
+ */
2816
+ getAudioTrackCount(): Promise<number>;
2817
+
2818
+ /**
2819
+ * Get caption track count from this sequence
2820
+ */
2821
+ getCaptionTrackCount(): Promise<number>;
2822
+
2823
+ /**
2824
+ * Get video track from track index
2825
+ *
2826
+ * @param trackIndex
2827
+ */
2828
+ getVideoTrack(trackIndex: number): Promise<VideoTrack>;
2829
+
2830
+ /**
2831
+ * Get audio track from track index
2832
+ *
2833
+ * @param trackIndex
2834
+ */
2835
+ getAudioTrack(trackIndex: number): Promise<AudioTrack>;
2836
+
2837
+ /**
2838
+ * Get caption track from track index
2839
+ *
2840
+ * @param trackIndex
2841
+ */
2842
+ getCaptionTrack(trackIndex: number): Promise<CaptionTrack>;
2843
+
2844
+ /**
2845
+ * Get sequence settings object
2846
+ */
2847
+ getSettings(): Promise<SequenceSettings>;
2848
+
2849
+ /**
2850
+ * Returns action that set sequence settings
2851
+ *
2852
+ * @param sequenceSettings
2853
+ */
2854
+ createSetSettingsAction(sequenceSettings: SequenceSettings): Action;
2855
+
2856
+ /**
2857
+ * Creates an action to clone the given sequence
2858
+ */
2859
+ createCloneAction(): Action;
2860
+
2861
+ /**
2862
+ * Returns a new sequence, which is a sub-sequence of the existing sequence
2863
+ *
2864
+ * @param ignoreTrackTargeting
2865
+ */
2866
+ createSubsequence(ignoreTrackTargeting?: boolean): Promise<Sequence>;
2867
+
2868
+ /**
2869
+ * Returns whether or not the sequence is done analyzing for video effects
2870
+ */
2871
+ isDoneAnalyzingForVideoEffects(): Promise<boolean>;
2872
+
2873
+ /**
2874
+ * Time representing the zero point of the sequence.
2875
+ */
2876
+ getZeroPoint(): Promise<TickTime>;
2877
+
2878
+ /**
2879
+ * Time representing the end of the sequence
2880
+ */
2881
+ getEndTime(): Promise<TickTime>;
2882
+
2883
+ /**
2884
+ * Get time representing the inPoint of sequence.
2885
+ */
2886
+ getInPoint(): Promise<TickTime>;
2887
+
2888
+ /**
2889
+ * Get time representing the inPoint of sequence.
2890
+ */
2891
+ getOutPoint(): Promise<TickTime>;
2892
+
2893
+ /**
2894
+ * Create SetInPointAction for sequence
2895
+ *
2896
+ * @param tickTime
2897
+ */
2898
+ createSetInPointAction(tickTime: TickTime): Action;
2899
+
2900
+ /**
2901
+ * Create an action to set an InPoint for the sequence
2902
+ *
2903
+ * @param tickTime
2904
+ */
2905
+ createSetZeroPointAction(tickTime: TickTime): Action;
2906
+
2907
+ /**
2908
+ * Create SetOutPointAction for sequence
2909
+ *
2910
+ * @param tickTime
2911
+ */
2912
+ createSetOutPointAction(tickTime: TickTime): Action;
2913
+
2914
+ /**
2915
+ * Get the associated projectItem of the sequence.
2916
+ */
2917
+ getProjectItem(): Promise<ProjectItem>;
2918
+
2919
+ /**
2920
+ * Returns the current selection group of the sequence.
2921
+ */
2922
+ getSelection(): Promise<TrackItemSelection>;
2923
+
2924
+ /**
2925
+ * Gets the size of the frame
2926
+ */
2927
+ getFrameSize(): Promise<RectF>;
2928
+
2929
+ /**
2930
+ * Gets the time base of sequence
2931
+ */
2932
+ getTimebase(): Promise<string>;
2933
+
2934
+ /**
2935
+ * The unique identifier of the sequence.
2936
+ * @readonly
2937
+ */
2938
+ readonly guid: Guid;
2939
+
2940
+ /**
2941
+ * The sequence name.
2942
+ * @readonly
2943
+ */
2944
+ readonly name: string;
2945
+ };
2946
+
2947
+ export declare type SequenceEditorStatic = {
2948
+ /**
2949
+ * Get Sequence Editor reference for editing the sequence timeline
2950
+ *
2951
+ * @param sequenceObject
2952
+ */
2953
+ getEditor(sequenceObject: Sequence): SequenceEditor;
2954
+
2955
+ /**
2956
+ * Get local directory path to adobe mogrt files
2957
+ */
2958
+ getInstalledMogrtPath(): Promise<string>;
2959
+ };
2960
+
2961
+ export declare type SequenceEditor = {
2962
+ /**
2963
+ * Create remove action for sequence
2964
+ *
2965
+ * @param trackItemSelection
2966
+ * @param ripple
2967
+ * @param mediaType
2968
+ * @param shiftOverLapping
2969
+ */
2970
+ createRemoveItemsAction(
2971
+ trackItemSelection: TrackItemSelection,
2972
+ ripple: boolean,
2973
+ mediaType: Constants.MediaType,
2974
+ shiftOverLapping?: boolean
2975
+ ): Action;
2976
+
2977
+ /**
2978
+ * Create insert ProjectItem into Sequence Action. Note: If you pass a track index greater than the number of existing tracks, a new track will be created.
2979
+ *
2980
+ * @param projectItem
2981
+ * @param time
2982
+ * @param videoTrackIndex
2983
+ * @param audioTrackIndex
2984
+ * @param limitShift
2985
+ */
2986
+ createInsertProjectItemAction(
2987
+ projectItem: ProjectItem,
2988
+ time: TickTime,
2989
+ videoTrackIndex: number,
2990
+ audioTrackIndex: number,
2991
+ limitShift: boolean
2992
+ ): Action;
2993
+
2994
+ /**
2995
+ * Create overwrite Sequence with ProjectItem Action
2996
+ *
2997
+ * @param projectItem
2998
+ * @param time
2999
+ * @param videoTrackIndex
3000
+ * @param audioTrackIndex
3001
+ */
3002
+ createOverwriteItemAction(
3003
+ projectItem: ProjectItem,
3004
+ time: TickTime,
3005
+ videoTrackIndex: number,
3006
+ audioTrackIndex: number
3007
+ ): Action;
3008
+
3009
+ /**
3010
+ * Duplicate trackItem using an insert or overwrite edit method to a destination track. Target track and start time of trackItem is determined using an offset value from the original trackItem position.
3011
+ *
3012
+ * @param trackItem
3013
+ * @param timeOffset
3014
+ * @param videoTrackVerticalOffset
3015
+ * @param audioTrackVerticalOffset
3016
+ * @param alignToVideo
3017
+ * @param isInsert
3018
+ */
3019
+ createCloneTrackItemAction(
3020
+ trackItem: VideoClipTrackItem | AudioClipTrackItem,
3021
+ timeOffset: TickTime,
3022
+ videoTrackVerticalOffset: number,
3023
+ audioTrackVerticalOffset: number,
3024
+ alignToVideo: boolean,
3025
+ isInsert: boolean
3026
+ ): Action;
3027
+
3028
+ /**
3029
+ * Insert input MGT into sequence with time and index defined
3030
+ *
3031
+ * @param inMGTPath
3032
+ * @param inTime
3033
+ * @param inVideoTrackIndex
3034
+ * @param inAudioTrackIndex
3035
+ */
3036
+ insertMogrtFromPath(
3037
+ inMGTPath: string,
3038
+ inTime: TickTime,
3039
+ inVideoTrackIndex: number,
3040
+ inAudioTrackIndex: number
3041
+ ): (VideoClipTrackItem | AudioClipTrackItem)[];
3042
+
3043
+ /**
3044
+ * Insert input MGT into sequence with time and index defined
3045
+ *
3046
+ * @param inLibraryName
3047
+ * @param inElementName
3048
+ * @param inTime
3049
+ * @param inVideoTrackIndex
3050
+ * @param inAudioTrackIndex
3051
+ */
3052
+ insertMogrtFromLibrary(
3053
+ inLibraryName: string,
3054
+ inElementName: string,
3055
+ inTime: TickTime,
3056
+ inVideoTrackIndex: number,
3057
+ inAudioTrackIndex: number
3058
+ ): (VideoClipTrackItem | AudioClipTrackItem)[];
3059
+ };
3060
+
3061
+ export declare type SequenceSettingsStatic = {
3062
+ /**
3063
+ * Square Pixels (1.0)
3064
+ * @readonly
3065
+ */
3066
+ readonly PAR_SQUARE: string;
3067
+
3068
+ /**
3069
+ * DV NTSC (0.9091)
3070
+ * @readonly
3071
+ */
3072
+ readonly PAR_DVNTSC: string;
3073
+
3074
+ /**
3075
+ * DV NTSC Widescreen 16:9 (1.2121)
3076
+ * @readonly
3077
+ */
3078
+ readonly PAR_DVNTSCWide: string;
3079
+
3080
+ /**
3081
+ * DV PAL (1.0940)
3082
+ * @readonly
3083
+ */
3084
+ readonly PAR_DVPAL: string;
3085
+
3086
+ /**
3087
+ * DV PAL Widescreen 16:9 (1.4587)
3088
+ * @readonly
3089
+ */
3090
+ readonly PAR_DVPALWide: string;
3091
+
3092
+ /**
3093
+ * Anamorphic 2:1 (2.0)
3094
+ * @readonly
3095
+ */
3096
+ readonly PAR_Anamorphic: string;
3097
+
3098
+ /**
3099
+ * HD Anamorphic 1080 (1.333)
3100
+ * @readonly
3101
+ */
3102
+ readonly PAR_HDAnamorphic1080: string;
3103
+
3104
+ /**
3105
+ * DVCPRO HD (1.5)
3106
+ * @readonly
3107
+ */
3108
+ readonly PAR_DVCProHD: string;
3109
+
3110
+ /**
3111
+ * Video field type progressive
3112
+ * @readonly
3113
+ */
3114
+ readonly VIDEO_FIELDTYPE_PROGRESSIVE: number;
3115
+
3116
+ /**
3117
+ * Video field type upper first
3118
+ * @readonly
3119
+ */
3120
+ readonly VIDEO_FIELDTYPE_UPPER_FIRST: number;
3121
+
3122
+ /**
3123
+ * Video field type lower first
3124
+ * @readonly
3125
+ */
3126
+ readonly VIDEO_FIELDTYPE_LOWER_FIRST: number;
3127
+
3128
+ /**
3129
+ * 23.976 fps TimeCode
3130
+ * @readonly
3131
+ */
3132
+ readonly VIDEO_DISPLAY_FORMAT_23976: number;
3133
+
3134
+ /**
3135
+ * 25 fps TimeCode
3136
+ * @readonly
3137
+ */
3138
+ readonly VIDEO_DISPLAY_FORMAT_25: number;
3139
+
3140
+ /**
3141
+ * 29.97 fps TimeCode
3142
+ * @readonly
3143
+ */
3144
+ readonly VIDEO_DISPLAY_FORMAT_2997: number;
3145
+
3146
+ /**
3147
+ * 29.97 fps Non-Drop-Frame TimeCode
3148
+ * @readonly
3149
+ */
3150
+ readonly VIDEO_DISPLAY_FORMAT_2997_NON_DROP: number;
3151
+
3152
+ /**
3153
+ * Feet+Frame 16mm
3154
+ * @readonly
3155
+ */
3156
+ readonly VIDEO_DISPLAY_FORMAT_16mm: number;
3157
+
3158
+ /**
3159
+ * Feet+Frame 35mm
3160
+ * @readonly
3161
+ */
3162
+ readonly VIDEO_DISPLAY_FORMAT_35mm: number;
3163
+
3164
+ /**
3165
+ * Frames
3166
+ * @readonly
3167
+ */
3168
+ readonly VIDEO_DISPLAY_FORMAT_FRAMES: number;
3169
+
3170
+ /**
3171
+ * Audio Channel Type Mono
3172
+ * @readonly
3173
+ */
3174
+ readonly AUDIO_CHANNEL_TYPE_MONO: number;
3175
+
3176
+ /**
3177
+ * Audio Channel Type Stereo
3178
+ * @readonly
3179
+ */
3180
+ readonly AUDIO_CHANNEL_TYPE_STEREO: number;
3181
+
3182
+ /**
3183
+ * Audio Channel Type 5.1
3184
+ * @readonly
3185
+ */
3186
+ readonly AUDIO_CHANNEL_TYPE_51: number;
3187
+
3188
+ /**
3189
+ * Audio Channel Type Multi
3190
+ * @readonly
3191
+ */
3192
+ readonly AUDIO_CHANNEL_TYPE_MULTI: number;
3193
+
3194
+ /**
3195
+ * Audio Display format: Audio Sample Timecode
3196
+ * @readonly
3197
+ */
3198
+ readonly AUDIO_DISPLAY_FORMAT_SAMPLE_RATE: number;
3199
+
3200
+ /**
3201
+ * Audio Display format miliseconds
3202
+ * @readonly
3203
+ */
3204
+ readonly AUDIO_DISPLAY_FORMAT_MILISECONDS: number;
3205
+ };
3206
+
3207
+ export declare type SequenceSettings = {
3208
+ /**
3209
+ * Find if maximum bit depth is set
3210
+ */
3211
+ getMaximumBitDepth(): Promise<boolean>;
3212
+
3213
+ /**
3214
+ * Set maximum bit depth to true/false
3215
+ *
3216
+ * @param useMaxBitDepth
3217
+ */
3218
+ setMaximumBitDepth(useMaxBitDepth: boolean): Promise<boolean>;
3219
+
3220
+ /**
3221
+ * Find if maximum render quality is set
3222
+ */
3223
+ getMaxRenderQuality(): Promise<boolean>;
3224
+
3225
+ /**
3226
+ * Set maximum render quality to true/false
3227
+ *
3228
+ * @param useMaxRenderQuality
3229
+ */
3230
+ setMaxRenderQuality(useMaxRenderQuality: boolean): Promise<boolean>;
3231
+
3232
+ /**
3233
+ * Get number of channels in the sequence
3234
+ */
3235
+ getAudioChannelCount(): Promise<number>;
3236
+
3237
+ /**
3238
+ * Get Audio channel type of sequence. Could be 0 (Mono), 1 (Stereo), 2 (5.1), or 3 (multichannel)
3239
+ */
3240
+ getAudioChannelType(): Promise<number>;
3241
+
3242
+ /**
3243
+ * Get Audio display format
3244
+ */
3245
+ getAudioDisplayFormat(): Promise<TimeDisplay>;
3246
+
3247
+ /**
3248
+ * Set audio display format of sequence.
3249
+ *
3250
+ * @param audioDisplay
3251
+ */
3252
+ setAudioDisplayFormat(audioDisplay: TimeDisplay): Promise<boolean>;
3253
+
3254
+ /**
3255
+ * Get audio sample rate
3256
+ */
3257
+ getAudioSampleRate(): Promise<FrameRate>;
3258
+
3259
+ /**
3260
+ * Set audio sample rate
3261
+ *
3262
+ * @param inRate
3263
+ */
3264
+ setAudioSampleRate(inRate: FrameRate): Promise<boolean>;
3265
+
3266
+ /**
3267
+ * Get Video display format
3268
+ */
3269
+ getVideoDisplayFormat(): Promise<TimeDisplay>;
3270
+
3271
+ /**
3272
+ * Set video display format of sequence
3273
+ *
3274
+ * @param audioDisplay
3275
+ */
3276
+ setVideoDisplayFormat(audioDisplay: TimeDisplay): Promise<boolean>;
3277
+
3278
+ /**
3279
+ * Get video field type in the sequence
3280
+ */
3281
+ getVideoFieldType(): Promise<number>;
3282
+
3283
+ /**
3284
+ * Set video field type in sequence
3285
+ *
3286
+ * @param videoFiledType
3287
+ */
3288
+ setVideoFieldType(videoFiledType: number): Promise<boolean>;
3289
+
3290
+ /**
3291
+ * Get video frame rate in the sequence
3292
+ */
3293
+ getVideoFrameRate(): FrameRate;
3294
+
3295
+ /**
3296
+ * Set video frame rate in the sequence
3297
+ *
3298
+ * @param inVideoFrameRate
3299
+ */
3300
+ setVideoFrameRate(inVideoFrameRate: FrameRate): boolean;
3301
+
3302
+ /**
3303
+ * Get video frame rect in the sequence
3304
+ */
3305
+ getVideoFrameRect(): Promise<RectF>;
3306
+
3307
+ /**
3308
+ * Set video frame rect in sequence
3309
+ *
3310
+ * @param inVideoFrameRect
3311
+ */
3312
+ setVideoFrameRect(inVideoFrameRect: RectF): Promise<boolean>;
3313
+
3314
+ /**
3315
+ * Get Video display format
3316
+ */
3317
+ getVideoPixelAspectRatio(): Promise<string>;
3318
+
3319
+ /**
3320
+ * Set video display format of sequence
3321
+ *
3322
+ * @param inPixelAspectRatio
3323
+ */
3324
+ setVideoPixelAspectRatio(inPixelAspectRatio: string): Promise<boolean>;
3325
+
3326
+ /**
3327
+ * Get if composite in linear color is checked
3328
+ */
3329
+ getCompositeInLinearColor(): Promise<boolean>;
3330
+
3331
+ /**
3332
+ * Set if composite in linear color is checked
3333
+ *
3334
+ * @param useCompositeInLinearColor
3335
+ */
3336
+ setCompositeInLinearColor(useCompositeInLinearColor: boolean): Promise<boolean>;
3337
+
3338
+ /**
3339
+ * Get editing mode of sequence
3340
+ */
3341
+ getEditingMode(): Promise<string>;
3342
+
3343
+ /**
3344
+ * Set editing mode of sequence
3345
+ *
3346
+ * @param inEditingModeName
3347
+ */
3348
+ setEditingMode(inEditingModeName: string): Promise<boolean>;
3349
+
3350
+ /**
3351
+ * Get preview file format of sequence
3352
+ */
3353
+ getPreviewFileFormat(): Promise<string>;
3354
+
3355
+ /**
3356
+ * Set preview file format of sequence
3357
+ *
3358
+ * @param inPreviewCodec
3359
+ */
3360
+ setPreviewFileFormat(inPreviewCodec: string): Promise<boolean>;
3361
+
3362
+ /**
3363
+ * Get preview codec of sequence
3364
+ */
3365
+ getPreviewCodec(): Promise<string>;
3366
+
3367
+ /**
3368
+ * Set preview codec of sequence
3369
+ *
3370
+ * @param inPreviewCodec
3371
+ */
3372
+ setPreviewCodec(inPreviewCodec: string): Promise<boolean>;
3373
+
3374
+ /**
3375
+ * Get preview video frame rect in the sequence
3376
+ */
3377
+ getPreviewFrameRect(): Promise<RectF>;
3378
+
3379
+ /**
3380
+ * Set preview video frame rect in sequence
3381
+ *
3382
+ * @param inPreviewVideoRect
3383
+ */
3384
+ setPreviewFrameRect(inPreviewVideoRect: RectF): Promise<boolean>;
3385
+ };
3386
+
3387
+ export declare type SequenceUtilsStatic = {
3388
+ /**
3389
+ * Performs cut detection on the sequence selection
3390
+ *
3391
+ * @param clipOperation
3392
+ * @param trackItemSelection
3393
+ */
3394
+ performSceneEditDetectionOnSelection(
3395
+ clipOperation: string,
3396
+ trackItemSelection: TrackItemSelection
3397
+ ): Promise<boolean>;
3398
+
3399
+ /**
3400
+ * ApplyCuts
3401
+ * @readonly
3402
+ */
3403
+ readonly SEQUENCE_OPERATION_APPLYCUT: string;
3404
+
3405
+ /**
3406
+ * CreateMarkers
3407
+ * @readonly
3408
+ */
3409
+ readonly SEQUENCE_OPERATION_CREATEMARKER: string;
3410
+
3411
+ /**
3412
+ * CreateSubclips
3413
+ * @readonly
3414
+ */
3415
+ readonly SEQUENCE_OPERATION_CREATESUBCLIP: string;
3416
+ };
3417
+
3418
+ export declare type SequenceUtils = {};
3419
+
3420
+ export declare type SnapEventStatic = {
3421
+ /**
3422
+ * Event occurs a user scrub on timeline over keyframes when shift key is applied.
3423
+ * @readonly
3424
+ */
3425
+ readonly EVENT_SNAP_TO_KEYFRAME: string;
3426
+
3427
+ /**
3428
+ * Event occurs a user scrub on timeline and snaps to various track item alignments.
3429
+ * @readonly
3430
+ */
3431
+ readonly EVENT_SNAP_TO_TRACKITEM: string;
3432
+
3433
+ /**
3434
+ * Event occurs object is snapped to guildelines when holding the Cmd/Ctrl key.
3435
+ * @readonly
3436
+ */
3437
+ readonly EVENT_SNAP_TO_GUIDES: string;
3438
+
3439
+ /**
3440
+ * Event occurs when the razor tool hovers over the playhead and snaps into position for a cut.
3441
+ * @readonly
3442
+ */
3443
+ readonly EVENT_SNAP_RAZOR_TO_PLAYHEAD: string;
3444
+
3445
+ /**
3446
+ * Event occurs when the razor tool hovers over the all types of markers and snaps into position for a cut.
3447
+ * @readonly
3448
+ */
3449
+ readonly EVENT_SNAP_RAZOR_TO_MARKER: string;
3450
+
3451
+ /**
3452
+ * Event occurs when the playhead snaps into track-item edges.
3453
+ * @readonly
3454
+ */
3455
+ readonly EVENT_SNAP_PLAYHEAD_TO_TRACKITEM_EDGE: string;
3456
+ };
3457
+
3458
+ export declare type SnapEvent = {};
3459
+
3460
+ export declare type SourceMonitorStatic = {
3461
+ /**
3462
+ * Open the item at the specified path and send to the Source Monitor for preview
3463
+ *
3464
+ * @param filePath
3465
+ */
3466
+ openFilePath(filePath: string): Promise<boolean>;
3467
+
3468
+ /**
3469
+ * Open input projectItem on Source Monitor
3470
+ *
3471
+ * @param projectItem
3472
+ */
3473
+ openProjectItem(projectItem: ProjectItem): Promise<boolean>;
3474
+
3475
+ /**
3476
+ * Close clip on Source Monitor
3477
+ */
3478
+ closeClip(): Promise<boolean>;
3479
+
3480
+ /**
3481
+ * Close all clips on Source Monitor
3482
+ */
3483
+ closeAllClips(): Promise<boolean>;
3484
+
3485
+ /**
3486
+ * Get position of source monitor in time
3487
+ */
3488
+ getPosition(): Promise<TickTime>;
3489
+
3490
+ /**
3491
+ * Play clip at source monitor with input speed
3492
+ *
3493
+ * @param speed
3494
+ */
3495
+ play(speed?: number): Promise<boolean>;
3496
+
3497
+ /**
3498
+ * Get projectItem at source monitor
3499
+ */
3500
+ getProjectItem(): Promise<ProjectItem>;
3501
+ };
3502
+
3503
+ export declare type SourceMonitor = {};
3504
+
3505
+ export declare type TextSegmentsStatic = {
3506
+ /**
3507
+ * Import text segments in JSON format for handling via callback.
3508
+ *
3509
+ * @param json
3510
+ * @param undefined
3511
+ */
3512
+ importFromJSON(json: string, callback1: (importedTranscription: TextSegments) => void): boolean;
3513
+ };
3514
+
3515
+ export declare type TextSegments = {};
3516
+
3517
+ export declare type TickTimeStatic = {
3518
+ /**
3519
+ * Constructs a TickTime object with a frame and a frame rate.
3520
+ *
3521
+ * @param frameCount
3522
+ * @param frameRate
3523
+ */
3524
+ createWithFrameAndFrameRate(frameCount: number, frameRate: FrameRate): TickTime;
3525
+
3526
+ /**
3527
+ * Constructs a TickTime object with seconds.
3528
+ *
3529
+ * @param seconds
3530
+ */
3531
+ createWithSeconds(seconds: number): TickTime;
3532
+
3533
+ /**
3534
+ * Constructs a TickTime object with ticks as a string.
3535
+ *
3536
+ * @param ticks
3537
+ */
3538
+ createWithTicks(ticks: string): TickTime;
3539
+
3540
+ /**
3541
+ * Zero Tick Time Constant
3542
+ * @readonly
3543
+ */
3544
+ readonly TIME_ZERO: TickTime;
3545
+
3546
+ /**
3547
+ * One Second Tick Time Constant
3548
+ * @readonly
3549
+ */
3550
+ readonly TIME_ONE_SECOND: TickTime;
3551
+
3552
+ /**
3553
+ * One Second Tick Time Constant
3554
+ * @readonly
3555
+ */
3556
+ readonly TIME_ONE_MINUTE: TickTime;
3557
+
3558
+ /**
3559
+ * One Hour Tick Time Constant
3560
+ * @readonly
3561
+ */
3562
+ readonly TIME_ONE_HOUR: TickTime;
3563
+
3564
+ /**
3565
+ * Max Tick Time Constant
3566
+ * @readonly
3567
+ */
3568
+ readonly TIME_MAX: TickTime;
3569
+
3570
+ /**
3571
+ * Min Tick Time Constant
3572
+ * @readonly
3573
+ */
3574
+ readonly TIME_MIN: TickTime;
3575
+
3576
+ /**
3577
+ * Invalid Tick Time Constant
3578
+ * @readonly
3579
+ */
3580
+ readonly TIME_INVALID: TickTime;
3581
+ };
3582
+
3583
+ export declare type TickTime = {
3584
+ /**
3585
+ * Constructs a new instance of the TickTime class.
3586
+ * @constructor
3587
+ */
3588
+ new (): TickTime;
3589
+ (): TickTime;
3590
+
3591
+ /**
3592
+ * Returns true if the given TickTime is equal to the TickTime object
3593
+ *
3594
+ * @param tickTime
3595
+ */
3596
+ equals(tickTime: TickTime): boolean;
3597
+
3598
+ /**
3599
+ * AlignToNearestFrame will return a TickTime that is aligned to the nearest frame boundary greater than or less than the given time, for a given frame rate by rounding any fractional portion.
3600
+ *
3601
+ * @param frameRate
3602
+ */
3603
+ alignToNearestFrame(frameRate: FrameRate): TickTime;
3604
+
3605
+ /**
3606
+ * alignToFrame will return a TickTime that is aligned to the nearest frame boundary less than the given time, for a given frame rate by rounding any fractional portion.
3607
+ *
3608
+ * @param frameRate
3609
+ */
3610
+ alignToFrame(frameRate: FrameRate): TickTime;
3611
+
3612
+ /**
3613
+ * Add another TickTime to this one and return it. This TickTime is not modified.
3614
+ *
3615
+ * @param tickTime
3616
+ */
3617
+ add(tickTime: TickTime): TickTime;
3618
+
3619
+ /**
3620
+ * Subtract another TickTime from this one and return it. This TickTime is not modified.
3621
+ *
3622
+ * @param tickTime
3623
+ */
3624
+ subtract(tickTime: TickTime): TickTime;
3625
+
3626
+ /**
3627
+ * Multiply this TickTime with a factor and return it. This TickTime is not modified.
3628
+ *
3629
+ * @param factor
3630
+ */
3631
+ multiply(factor: number): TickTime;
3632
+
3633
+ /**
3634
+ * Divide this TickTime by a divisor and return it. In case of a division by zero, TIME_INVALID is returned. This TickTime is not modified.
3635
+ *
3636
+ * @param divisor
3637
+ */
3638
+ divide(divisor: number): TickTime;
3639
+
3640
+ /**
3641
+ * Get the TickTime in seconds
3642
+ * @readonly
3643
+ */
3644
+ readonly seconds: number;
3645
+
3646
+ /**
3647
+ * Get the TickTime in ticks as a string
3648
+ * @readonly
3649
+ */
3650
+ readonly ticks: string;
3651
+
3652
+ /**
3653
+ * Get the TickTime in ticks as a number
3654
+ * @readonly
3655
+ */
3656
+ readonly ticksNumber: number;
3657
+ };
3658
+
3659
+ export declare type TimeDisplay = {
3660
+ /**
3661
+ * Read/Write property to get/set the time display type numeric code
3662
+ */
3663
+ type: number;
3664
+ };
3665
+
3666
+ export declare type TrackItemSelectionStatic = {
3667
+ /**
3668
+ * Create empty selection
3669
+ *
3670
+ * @param undefined
3671
+ */
3672
+ createEmptySelection(callback0: (selection: TrackItemSelection) => void): boolean;
3673
+ };
3674
+
3675
+ export declare type TrackItemSelection = {
3676
+ /**
3677
+ * Add a track item to this selection
3678
+ *
3679
+ * @param trackItem trackItem to be added to selection
3680
+ * @param skipDuplicateCheck
3681
+ */
3682
+ addItem(
3683
+ trackItem: VideoClipTrackItem | AudioClipTrackItem,
3684
+ skipDuplicateCheck?: boolean
3685
+ ): boolean;
3686
+
3687
+ /**
3688
+ * Remove a track item from this selection
3689
+ *
3690
+ * @param trackItem trackItem to be removed from selection
3691
+ */
3692
+ removeItem(trackItem: VideoClipTrackItem | AudioClipTrackItem): boolean;
3693
+
3694
+ /**
3695
+ * return list of trackItems inside of trackItemSelection
3696
+ */
3697
+ getTrackItems(): Promise<(VideoClipTrackItem | AudioClipTrackItem)[]>;
3698
+ };
3699
+
3700
+ export declare type TransitionFactoryStatic = {
3701
+ /**
3702
+ * Creates a new video filter component based on the input matchName
3703
+ *
3704
+ * @param matchName
3705
+ */
3706
+ createVideoTransition(matchName: string): VideoTransition;
3707
+
3708
+ /**
3709
+ * Return a promise which will be fullfilled with an array of video transition matchnames
3710
+ */
3711
+ getVideoTransitionMatchNames(): Promise<string[]>;
3712
+ };
3713
+
3714
+ export declare type TransitionFactory = {};
3715
+
3716
+ export declare type UniqueSerializeableStatic = {
3717
+ /**
3718
+ * Cast serializable object (ex. ProjectItem) into UniqueSerializeable
3719
+ *
3720
+ * @param item
3721
+ */
3722
+ cast(item: ProjectItem | ClipProjectItem | FolderItem | Sequence): UniqueSerializeable;
3723
+ };
3724
+
3725
+ export declare type UniqueSerializeable = {
3726
+ /**
3727
+ * Get the unique ID of the serializeable object
3728
+ */
3729
+ getUniqueID(): Guid;
3730
+ };
3731
+
3732
+ export declare type UtilsStatic = {
3733
+ /**
3734
+ * Check if AE is installed.
3735
+ */
3736
+ isAEInstalled(): Promise<boolean>;
3737
+ };
3738
+
3739
+ export declare type Utils = {};
3740
+
3741
+ export declare type VideoClipTrackItemStatic = {
3742
+ /**
3743
+ * Empty Track Item Type
3744
+ * @readonly
3745
+ */
3746
+ readonly TRACKITEMTYPE_EMPTY: number;
3747
+
3748
+ /**
3749
+ * Clip Track Item Type
3750
+ * @readonly
3751
+ */
3752
+ readonly TRACKITEMTYPE_CLIP: number;
3753
+
3754
+ /**
3755
+ * Transition Track Item Type
3756
+ * @readonly
3757
+ */
3758
+ readonly TRACKITEMTYPE_TRANSITION: number;
3759
+
3760
+ /**
3761
+ * Previe Track Item Type
3762
+ * @readonly
3763
+ */
3764
+ readonly TRACKITEMTYPE_PREVIEW: number;
3765
+
3766
+ /**
3767
+ * Feedback Track Item Type
3768
+ * @readonly
3769
+ */
3770
+ readonly TRACKITEMTYPE_FEEDBACK: number;
3771
+ };
3772
+
3773
+ export declare type VideoClipTrackItem = {
3774
+ /**
3775
+ * Create add transition action for sequence
3776
+ *
3777
+ * @param videoTransition
3778
+ * @param addTransitionOptionsProperties
3779
+ */
3780
+ createAddVideoTransitionAction(
3781
+ videoTransition: VideoTransition,
3782
+ addTransitionOptionsProperties?: AddTransitionOptions
3783
+ ): Action;
3784
+
3785
+ /**
3786
+ * Returns true if trackItem has transition
3787
+ *
3788
+ * @param transitionPosition Start or end position of transition
3789
+ */
3790
+ createRemoveVideoTransitionAction(transitionPosition?: Constants.TransitionPosition): Action;
3791
+
3792
+ /**
3793
+ * Returns the value of internal matchname for this trackItem
3794
+ */
3795
+ getMatchName(): Promise<string>;
3796
+
3797
+ /**
3798
+ * Returns the display name for trackItem
3799
+ */
3800
+ getName(): Promise<string>;
3801
+
3802
+ /**
3803
+ * Returns if trackItem is selected or not
3804
+ */
3805
+ getIsSelected(): Promise<boolean>;
3806
+
3807
+ /**
3808
+ * Returns the value of speed of the trackItem
3809
+ */
3810
+ getSpeed(): Promise<number>;
3811
+
3812
+ /**
3813
+ * Returns true if the trackitem is an adjustment layer
3814
+ */
3815
+ isAdjustmentLayer(): Promise<boolean>;
3816
+
3817
+ /**
3818
+ * Returns true if the trackitem is reversed
3819
+ */
3820
+ isSpeedReversed(): Promise<number>;
3821
+
3822
+ /**
3823
+ * Returns an action that moves the inPoint of the track item to a new time, by shifting it by a number of seconds.
3824
+ *
3825
+ * @param tickTime
3826
+ */
3827
+ createMoveAction(tickTime: TickTime): Action;
3828
+
3829
+ /**
3830
+ * Returns a TickTime object representing the track item in point relative to the start time of the project item referenced by this track item.
3831
+ */
3832
+ getInPoint(): Promise<TickTime>;
3833
+
3834
+ /**
3835
+ * Returns a TickTime object representing the track item out point relative to the start time of the project item referenced by this track item.
3836
+ */
3837
+ getOutPoint(): Promise<TickTime>;
3838
+
3839
+ /**
3840
+ * Create SetInPointAction for setting the track item in point relative to the start time of the project item referenced by this track item
3841
+ *
3842
+ * @param tickTime Sets the In-Point in TickTime
3843
+ */
3844
+ createSetInPointAction(tickTime: TickTime): Action;
3845
+
3846
+ /**
3847
+ * Create SetOutPointAction for setting the track item out point relative to the start time of the project item referenced by this track item
3848
+ *
3849
+ * @param tickTime Sets the Out-Point in TickTime
3850
+ */
3851
+ createSetOutPointAction(tickTime: TickTime): Action;
3852
+
3853
+ /**
3854
+ * Returns a TickTime object representing the starting sequence time of this track item relative to the sequence start time.
3855
+ */
3856
+ getStartTime(): Promise<TickTime>;
3857
+
3858
+ /**
3859
+ * Returns a TickTime object representing the ending sequence time of this track item relative to the sequence start time.
3860
+ */
3861
+ getEndTime(): Promise<TickTime>;
3862
+
3863
+ /**
3864
+ * Create set start time action for sequence
3865
+ *
3866
+ * @param tickTime
3867
+ */
3868
+ createSetStartAction(tickTime: TickTime): Action;
3869
+
3870
+ /**
3871
+ * Create set end time action for sequence
3872
+ *
3873
+ * @param tickTime
3874
+ */
3875
+ createSetEndAction(tickTime: TickTime): Action;
3876
+
3877
+ /**
3878
+ * Returns timecode representing the duration of this track item relative to the sequence start.
3879
+ */
3880
+ getDuration(): Promise<TickTime>;
3881
+
3882
+ /**
3883
+ * Index representing the type of this track item.
3884
+ */
3885
+ getType(): Promise<number>;
3886
+
3887
+ /**
3888
+ * Returns true if trackitem is muted/disabled
3889
+ */
3890
+ isDisabled(): Promise<boolean>;
3891
+
3892
+ /**
3893
+ * Returns an action that enables/disables the trackItem
3894
+ *
3895
+ * @param disabled
3896
+ */
3897
+ createSetDisabledAction(disabled: boolean): Action;
3898
+
3899
+ /**
3900
+ * Returns an action that renames the trackItem
3901
+ *
3902
+ * @param inName
3903
+ */
3904
+ createSetNameAction(inName: string): Action;
3905
+
3906
+ /**
3907
+ * Returns UUID representing the underlying media type of this track item
3908
+ */
3909
+ getMediaType(): Promise<Guid>;
3910
+
3911
+ /**
3912
+ * Index representing the track index of the track this track item belongs to
3913
+ */
3914
+ getTrackIndex(): Promise<number>;
3915
+
3916
+ /**
3917
+ * Returns the project item for this track item.
3918
+ */
3919
+ getProjectItem(): Promise<ProjectItem>;
3920
+
3921
+ /**
3922
+ * Returns VideoComponentChain
3923
+ */
3924
+ getComponentChain(): Promise<VideoComponentChain>;
3925
+ };
3926
+
3927
+ export declare type VideoComponentChainStatic = {};
3928
+
3929
+ export declare type VideoComponentChain = {
3930
+ /**
3931
+ * Creates and returns an insert component action
3932
+ *
3933
+ * @param component Video filter component
3934
+ * @param componentInsertionIndex Index which the component shall be inserted
3935
+ */
3936
+ createInsertComponentAction(
3937
+ component: Component | VideoFilterComponent,
3938
+ componentInsertionIndex: number
3939
+ ): Action;
3940
+
3941
+ /**
3942
+ * Creates and returns an append component action
3943
+ *
3944
+ * @param component Video filter component
3945
+ */
3946
+ createAppendComponentAction(component: Component | VideoFilterComponent): Action;
3947
+
3948
+ /**
3949
+ * Creates and returns an remove component action
3950
+ *
3951
+ * @param component Video filter component
3952
+ */
3953
+ createRemoveComponentAction(component: Component | VideoFilterComponent): Action;
3954
+
3955
+ /**
3956
+ * Returns the component at the given index
3957
+ *
3958
+ * @param componentIndex
3959
+ * @returns Returns the component at the given index
3960
+ */
3961
+ getComponentAtIndex(componentIndex: number): Component;
3962
+
3963
+ /**
3964
+ * Gets the number of components in the component chain
3965
+ */
3966
+ getComponentCount(): number;
3967
+ };
3968
+
3969
+ export declare type VideoFilterComponentStatic = {};
3970
+
3971
+ export declare type VideoFilterComponent = {};
3972
+
3973
+ export declare type VideoFilterFactoryStatic = {
3974
+ /**
3975
+ * Creates a new video filter component based on the input matchName
3976
+ *
3977
+ * @param matchName The match name of the component to create, example 'PR.ADBE Solarize', 'AE.ADBE Mosaic' etc..
3978
+ */
3979
+ createComponent(matchName: string): Promise<VideoFilterComponent>;
3980
+
3981
+ /**
3982
+ * Returns an array of video filter matchNames
3983
+ */
3984
+ getMatchNames(): Promise<string[]>;
3985
+
3986
+ /**
3987
+ * Returns an array of video filter display names
3988
+ */
3989
+ getDisplayNames(): Promise<string[]>;
3990
+ };
3991
+
3992
+ export declare type VideoFilterFactory = {};
3993
+
3994
+ export declare type VideoTrackStatic = {
3995
+ /**
3996
+ * Event Object for Track changed
3997
+ * @readonly
3998
+ */
3999
+ readonly EVENT_TRACK_CHANGED: string;
4000
+
4001
+ /**
4002
+ * Event Object for Track Info Changed
4003
+ * @readonly
4004
+ */
4005
+ readonly EVENT_TRACK_INFO_CHANGED: string;
4006
+
4007
+ /**
4008
+ * Event Object for Track Lock Changed
4009
+ * @readonly
4010
+ */
4011
+ readonly EVENT_TRACK_LOCK_CHANGED: string;
4012
+ };
4013
+
4014
+ export declare type VideoTrack = {
4015
+ /**
4016
+ * sets the mute state of the track to muted/unmuted
4017
+ *
4018
+ * @param mute
4019
+ */
4020
+ setMute(mute: boolean): Promise<boolean>;
4021
+
4022
+ /**
4023
+ * UUID representing the underlying media type of this track
4024
+ */
4025
+ getMediaType(): Promise<Guid>;
4026
+
4027
+ /**
4028
+ * Index representing the track index of this track within the track group.
4029
+ */
4030
+ getIndex(): Promise<number>;
4031
+
4032
+ /**
4033
+ * Get mute state of the track
4034
+ */
4035
+ isMuted(): Promise<boolean>;
4036
+
4037
+ /**
4038
+ * Returns array of VideoClipTrackItem from the track item type
4039
+ *
4040
+ * @param trackItemType This values can be Empty (0), Clip (1), Transition (2), Preview (3) or Feedback (4)
4041
+ * @param includeEmptyTrackItems
4042
+ */
4043
+ getTrackItems(
4044
+ trackItemType: Constants.TrackItemType,
4045
+ includeEmptyTrackItems: boolean
4046
+ ): VideoClipTrackItem[];
4047
+
4048
+ /**
4049
+ * Get the name of the track
4050
+ * @readonly
4051
+ */
4052
+ readonly name: string;
4053
+
4054
+ /**
4055
+ * The ID of the track within the TrackGroup
4056
+ * @readonly
4057
+ */
4058
+ readonly id: number;
4059
+ };
4060
+
4061
+ export declare type VideoTransitionStatic = {
4062
+ /**
4063
+ * TransitionPosition: START
4064
+ * @readonly
4065
+ */
4066
+ readonly TRANSITIONPOSITION_START: number;
4067
+
4068
+ /**
4069
+ * TransitionPosition: END
4070
+ * @readonly
4071
+ */
4072
+ readonly TRANSITIONPOSITION_END: number;
4073
+ };
4074
+
4075
+ export declare type VideoTransition = {};
4076
+
4077
+ export declare type EventManagerStatic = {
4078
+ /**
4079
+ * add event listener to target object
4080
+ *
4081
+ * @param target
4082
+ * @param eventName
4083
+ * @param eventHandler
4084
+ * @param inCapturePhase?
4085
+ */
4086
+ addEventListener(
4087
+ target: Project | Sequence | VideoTrack | AudioTrack | EncoderManager,
4088
+ eventName:
4089
+ | string
4090
+ | Constants.SnapEvent
4091
+ | Constants.ProjectEvent
4092
+ | Constants.SequenceEvent
4093
+ | Constants.OperationCompleteEvent,
4094
+ eventHandler: (event?: object) => void,
4095
+ inCapturePhase?: boolean
4096
+ ): void;
4097
+
4098
+ /**
4099
+ * remove event listener from target object
4100
+ *
4101
+ * @param target
4102
+ * @param eventName
4103
+ * @param eventHandler
4104
+ */
4105
+ removeEventListener(
4106
+ target: Project | Sequence | VideoTrack | AudioTrack | EncoderManager,
4107
+ eventName:
4108
+ | string
4109
+ | Constants.SnapEvent
4110
+ | Constants.ProjectEvent
4111
+ | Constants.SequenceEvent
4112
+ | Constants.OperationCompleteEvent,
4113
+ eventHandler: (event?: object) => void
4114
+ ): void;
4115
+
4116
+ /**
4117
+ * add global event listener
4118
+ *
4119
+ * @param eventName
4120
+ * @param eventHandler
4121
+ * @param inCapturePhase?
4122
+ */
4123
+ addGlobalEventListener(
4124
+ eventName:
4125
+ | string
4126
+ | Constants.SnapEvent
4127
+ | Constants.ProjectEvent
4128
+ | Constants.SequenceEvent
4129
+ | Constants.OperationCompleteEvent,
4130
+ eventHandler: (event?: object) => void,
4131
+ inCapturePhase?: boolean
4132
+ ): void;
4133
+
4134
+ /**
4135
+ * remove global event listener
4136
+ *
4137
+ * @param eventName
4138
+ * @param eventHandler
4139
+ */
4140
+ removeGlobalEventListener(
4141
+ eventName:
4142
+ | string
4143
+ | Constants.SnapEvent
4144
+ | Constants.ProjectEvent
4145
+ | Constants.SequenceEvent
4146
+ | Constants.OperationCompleteEvent,
4147
+ eventHandler: (event?: object) => void
4148
+ ): void;
4149
+ };
4150
+
4151
+ export declare type EventManager = {};
4152
+
4153
+ export declare type TranscriptStatic = {
4154
+ /**
4155
+ * Returns TextSegments object initialized from jsonString
4156
+ *
4157
+ * @param jsonString
4158
+ */
4159
+ importFromJSON(jsonString: string): TextSegments;
4160
+
4161
+ /**
4162
+ * Create action that import external transcripts to ClipProjectItem
4163
+ *
4164
+ * @param textSegments
4165
+ * @param clipProjectItem
4166
+ */
4167
+ createImportTextSegmentsAction(
4168
+ textSegments: TextSegments,
4169
+ clipProjectItem: ClipProjectItem
4170
+ ): Action;
4171
+
4172
+ /**
4173
+ * Export transcripts inside of clipProjectItem as JSON string if transcript exist
4174
+ *
4175
+ * @param clipProjectItem
4176
+ */
4177
+ exportToJSON(clipProjectItem: ClipProjectItem): Promise<string>;
4178
+ };
4179
+
4180
+ export declare type Transcript = {};
4181
+
4182
+ export namespace Constants {
4183
+ export enum AudioChannelType {
4184
+ MONO,
4185
+ STEREO,
4186
+ SURROUND_51,
4187
+ MULTI,
4188
+ }
4189
+
4190
+ export enum AudioDisplayFormatType {
4191
+ SAMPLE_RATE,
4192
+ MILLISECONDS,
4193
+ }
4194
+
4195
+ export enum AudioTrackEvent {
4196
+ TRACK_CHANGED,
4197
+ INFO_CHANGED,
4198
+ LOCK_CHANGED,
4199
+ }
4200
+
4201
+ export enum ContentType {
4202
+ ANY,
4203
+ SEQUENCE,
4204
+ MEDIA,
4205
+ }
4206
+
4207
+ export enum EncoderEvent {
4208
+ RENDER_COMPLETE,
4209
+ RENDER_ERROR,
4210
+ RENDER_CANCEL,
4211
+ RENDER_QUEUE,
4212
+ RENDER_PROGRESS,
4213
+ }
4214
+
4215
+ export enum ExportType {
4216
+ QUEUE_TO_AME,
4217
+ QUEUE_TO_APP,
4218
+ IMMEDIATELY,
4219
+ }
4220
+
4221
+ export enum InterpolationMode {
4222
+ BEZIER,
4223
+ HOLD,
4224
+ LINEAR,
4225
+ TIME,
4226
+ TIME_TRANSITION_END,
4227
+ TIME_TRANSITION_START,
4228
+ }
4229
+
4230
+ export enum MarkerColor {
4231
+ GREEN,
4232
+ RED,
4233
+ MAGNETA,
4234
+ ORANGE,
4235
+ YELLOW,
4236
+ BLUE,
4237
+ CYAN,
4238
+ }
4239
+
4240
+ export enum MediaType {
4241
+ ANY,
4242
+ DATA,
4243
+ VIDEO,
4244
+ AUDIO,
4245
+ }
4246
+
4247
+ export enum MetadataType {
4248
+ INTEGER,
4249
+ REAL,
4250
+ TEXT,
4251
+ BOOLEAN,
4252
+ }
4253
+
4254
+ export enum OperationCompleteEvent {
4255
+ CLIP_EXTEND_REACHED,
4256
+ EFFECT_DROP_COMPLETE,
4257
+ EFFECT_DRAG_OVER,
4258
+ EXPORT_MEDIA_COMPLETE,
4259
+ GENERATIVE_EXTEND_COMPLETE,
4260
+ IMPORT_MEDIA_COMPLETE,
4261
+ }
4262
+
4263
+ export enum OperationCompleteState {
4264
+ SUCCESS,
4265
+ CANCELLED,
4266
+ FAILED,
4267
+ }
4268
+
4269
+ export enum PixelAspectRatio {
4270
+ SQUARE,
4271
+ DVNTSC,
4272
+ DVNTSCWide,
4273
+ DVPAL,
4274
+ DVPALWide,
4275
+ Anamorphic,
4276
+ HDAnamorphic1080,
4277
+ DVCProHD,
4278
+ }
4279
+
4280
+ export enum PreferenceKey {
4281
+ AUTO_PEAK_GENERATION,
4282
+ IMPORT_WORKSPACE,
4283
+ SHOW_QUICKSTART_DIALOG,
4284
+ }
4285
+
4286
+ export enum ProjectEvent {
4287
+ OPENED,
4288
+ CLOSED,
4289
+ DIRTY,
4290
+ ACTIVATED,
4291
+ PROJECT_ITEM_SELECTION_CHANGED,
4292
+ }
4293
+
4294
+ export enum ProjectItemColorLabel {
4295
+ VIOLET,
4296
+ IRIS,
4297
+ LAVENDER,
4298
+ CERULEAN,
4299
+ FOREST,
4300
+ ROSE,
4301
+ MANGO,
4302
+ PURPLE,
4303
+ BLUE,
4304
+ TEAL,
4305
+ MAGENTA,
4306
+ TAN,
4307
+ GREEN,
4308
+ BROWN,
4309
+ YELLOW,
4310
+ }
4311
+
4312
+ export enum PropertyType {
4313
+ PERSISTENT,
4314
+ NON_PERSISTENT,
4315
+ }
4316
+
4317
+ export enum ScratchDiskFolder {
4318
+ SAME_AS_PROJECT,
4319
+ MY_DOCUMENTS,
4320
+ }
4321
+
4322
+ export enum ScratchDiskFolderType {
4323
+ CAPTURE,
4324
+ AUDIO_PREVIEW,
4325
+ VIDEO_PREVIEW,
4326
+ AUTO_SAVE,
4327
+ CCL_LIBRARIES,
4328
+ CAPSULE_MEDIA,
4329
+ }
4330
+
4331
+ export enum SequenceEvent {
4332
+ ACTIVATED,
4333
+ CLOSED,
4334
+ SELECTION_CHANGED,
4335
+ }
4336
+
4337
+ export enum SequenceOperation {
4338
+ APPLYCUT,
4339
+ CREATEMARKER,
4340
+ CREATESUBCLIP,
4341
+ }
4342
+
4343
+ export enum SnapEvent {
4344
+ KEYFRAME,
4345
+ RAZOR_PLAYHEAD,
4346
+ RAZOR_MARKER,
4347
+ TRACKITEM,
4348
+ GUIDES,
4349
+ PLAYHEAD_TRACKITEM,
4350
+ }
4351
+
4352
+ export enum TrackItemType {
4353
+ EMPTY,
4354
+ CLIP,
4355
+ TRANSITION,
4356
+ PREVIEW,
4357
+ FEEDBACK,
4358
+ }
4359
+
4360
+ export enum TransitionPosition {
4361
+ START,
4362
+ END,
4363
+ }
4364
+
4365
+ export enum VideoDisplayFormatType {
4366
+ FPS_23_976,
4367
+ FPS_25,
4368
+ FPS_29_97,
4369
+ FPS_29_97_NON_DROP,
4370
+ FEET_FRAME_16mm,
4371
+ FEET_FRAME_35mm,
4372
+ FRAMES,
4373
+ }
4374
+
4375
+ export enum VideoFieldType {
4376
+ PROGRESSIVE,
4377
+ UPPER_FIRST,
4378
+ LOWER_FIRST,
4379
+ }
4380
+
4381
+ export enum VideoTrackEvent {
4382
+ TRACK_CHANGED,
4383
+ INFO_CHANGED,
4384
+ LOCK_CHANGED,
4385
+ }
4386
+ }
4387
+
4388
+ export default premierepro;