@adobe/premierepro 26.5.0-beta.3 → 26.5.0-beta.61

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/premierepro",
-  "version": "26.5.0-beta.3",
+  "version": "26.5.0-beta.61",
   "description": "The TypeScript definitions and declarations for UXP APIs in Premiere",
   "license": "Apache-2.0",
   "bugs": {

package/src/premierepro.d.ts

@@ -40,6 +40,7 @@ export declare type premierepro = {
   Marker: MarkerStatic;
   Markers: MarkersStatic;
   Media: Media;
+  MediaManager: MediaManagerStatic;
   Metadata: MetadataStatic;
   ObjectMaskUtils: ObjectMaskUtilsStatic;
   OpenProjectOptions: OpenProjectOptions;
@@ -78,6 +79,7 @@ export declare type premierepro = {
   VideoFilterFactory: VideoFilterFactoryStatic;
   VideoTrack: VideoTrackStatic;
   VideoTransition: VideoTransitionStatic;
+  WorkAreaUtils: WorkAreaUtilsStatic;
   EventManager: EventManagerStatic;
   Transcript: TranscriptStatic;
   Constants: typeof Constants;
@@ -313,7 +315,7 @@ export declare type AddTransitionOptions = {
 
 export declare type AppPreferenceStatic = {
   /**
-   * Set backend preference using given list of property keys. The parameters are <key, value (number, boolean or string), persistence flag>
+   * Set backend preference using one of the available property keys
    *
    * @param key App preference key to set
    * @param value Value to set for the preference key
@@ -369,7 +371,7 @@ export declare type Application = {
   /**
    * @readonly
    */
-  readonly version: string;
+  readonly version: Promise<string>;
 };
 
 export declare type AudioClipTrackItemStatic = {
@@ -837,7 +839,7 @@ export declare type ClipProjectItem = {
   changeMediaFilePath(newPath: string, overrideCompatibilityCheck?: boolean): Promise<boolean>;
 
   /**
-   * Returns a deferred Action that creates a subclip when committed inside a transaction. hasHardBoundaries: if true, prevents trimming beyond the subclip boundaries. Accepts additional options (defaults to true): { takeVideo?: boolean, takeAudio?: boolean }.
+   * Returns a deferred Action that creates a subclip when committed inside a transaction. hasHardBoundaries: if true, prevents trimming beyond the subclip boundaries. Takes additional options (defaulting to true).
    *
    * @param name
    * @param startTime
@@ -850,7 +852,7 @@ export declare type ClipProjectItem = {
     startTime: TickTime,
     endTime: TickTime,
     hasHardBoundaries: boolean,
-    options?: object
+    options?: { takeVideo?: boolean; takeAudio?: boolean }
   ): Action;
 
   /**
@@ -927,11 +929,13 @@ export declare type ClipProjectItem = {
   getMediaFilePath(): Promise<string>;
 
   /**
-   * Get the media file path of the Project item.
+   * Get the component chain of the Project item for the given media type.
    *
-   * @param mediaType Media type can be audio, video or data/caption
+   * @param mediaType Media type can be audio or video
    */
-  getComponentChain(mediaType: Constants.MediaType): Promise<string>;
+  getComponentChain(
+    mediaType: Constants.MediaType
+  ): Promise<AudioComponentChain | VideoComponentChain | null>;
 
   /**
    * Returns an action which Sets the in point of the Project item
@@ -943,17 +947,17 @@ export declare type ClipProjectItem = {
   /**
    * Returns an action which sets Override pixel aspect ratio
    *
-   * @param inNumerator
-   * @param inDenominator
+   * @param numerator
+   * @param denominator
    */
-  createSetOverridePixelAspectRatioAction(inNumerator: number, inDenominator: number): Action;
+  createSetOverridePixelAspectRatioAction(numerator: number, denominator: number): Action;
 
   /**
    * Returns an action which sets the override frame rate
    *
-   * @param inOverriddenFrameRateValue
+   * @param overriddenFrameRateValue
    */
-  createSetOverrideFrameRateAction(inOverriddenFrameRateValue: number): Action;
+  createSetOverrideFrameRateAction(overriddenFrameRateValue: number): Action;
 
   /**
    * Returns an action which Sets the in point of the Project item
@@ -1953,7 +1957,7 @@ export declare type Marker = {
   /**
    * Return an action to set the type of the marker.
    *
-   * @param markerType This values can be Scale (0), AnchorToInPoint (1) or AnchorToOutPoint (2)
+   * @param markerType Can be set to "Comment", "Chapter", "Segmentation", or "WebLink"
    */
   createSetTypeAction(markerType: string): Action;
 
@@ -2006,14 +2010,14 @@ export declare type Markers = {
   /**
    * Add a new marker
    *
-   * @param Name
+   * @param name
    * @param markerType
    * @param startTime
    * @param duration
    * @param comments
    */
   createAddMarkerAction(
-    Name: string,
+    name: string,
     markerType?: string,
     startTime?: TickTime,
     duration?: TickTime,
@@ -2029,19 +2033,40 @@ export declare type Media = {
    */
   createSetStartAction(time: TickTime): Action;
 
+  /**
+   * Get the media start time.
+   */
+  getStart(): TickTime;
+
+  /**
+   * Get the media duration.
+   */
+  getDuration(): TickTime;
+
   /**
    * Get the media start time
    * @readonly
+   * @deprecated Use getStart() instead.
    */
-  readonly start: TickTime;
+  readonly start: Promise<TickTime>;
 
   /**
    * Get the media duration
    * @readonly
+   * @deprecated Use getDuration() instead.
    */
-  readonly duration: TickTime;
+  readonly duration: Promise<TickTime>;
 };
 
+export declare type MediaManagerStatic = {
+  /**
+   * Flush the media cache.
+   */
+  purgeMediaCache(): Promise<boolean>;
+};
+
+export declare type MediaManager = {};
+
 export declare type MetadataStatic = {
   /**
    * Get project metadata
@@ -2389,7 +2414,7 @@ export declare type Project = {
   createSequenceWithPresetPath(name: string, presetPath: string): Promise<Sequence>;
 
   /**
-   * Create a new sequence with a given name and medias
+   * Create a new sequence with a given name and media
    *
    * @param name
    * @param clipProjectItems
@@ -2443,16 +2468,16 @@ export declare type Project = {
    *
    * @param aepPath
    * @param compNames
-   * @param TargetBin
+   * @param targetBin
    */
-  importAEComps(aepPath: string, compNames: string[], TargetBin?: ProjectItem): Promise<boolean>;
+  importAEComps(aepPath: string, compNames: string[], targetBin?: ProjectItem): Promise<boolean>;
 
   /**
    *
    * @param aepPath
-   * @param TargetBin
+   * @param targetBin
    */
-  importAllAEComps(aepPath: string, TargetBin?: ProjectItem): Promise<boolean>;
+  importAllAEComps(aepPath: string, targetBin?: ProjectItem): Promise<boolean>;
 
   /**
    * Import files in root/target bin of the project
@@ -2506,7 +2531,7 @@ export declare type Project = {
   getRootItem(): Promise<FolderItem>;
 
   /**
-   * Pause growing of files instead swap the files
+   * Pauses or resumes monitoring of actively-captured (growing) media files in the project. When paused, Premiere stops refreshing clips whose source files are still being written to disk, allowing stable playback at the current captured duration. Pass true to pause, false to resume.
    *
    * @param pause
    */
@@ -2908,7 +2933,7 @@ export declare type Properties = {
   getValue(name: string): string;
 
   /**
-   * 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.
+   * Create an action to set a named value through scripting. This method can fail if e.g. the underlying properties object does not support action based setting of properties.
    *
    * @param name property name
    * @param value Value to set for the property key
@@ -3103,7 +3128,7 @@ export declare type Sequence = {
   getSettings(): Promise<SequenceSettings>;
 
   /**
-   * Returns action that set sequence settings
+   * Returns an action that updates the settings for the sequence.
    *
    * @param sequenceSettings
    */
@@ -3137,12 +3162,12 @@ export declare type Sequence = {
   getEndTime(): Promise<TickTime>;
 
   /**
-   * Get time representing the inPoint of sequence.
+   * Get time representing the in point of the sequence.
    */
   getInPoint(): Promise<TickTime>;
 
   /**
-   * Get time representing the inPoint of sequence.
+   * Get time representing the out point of the sequence.
    */
   getOutPoint(): Promise<TickTime>;
 
@@ -3154,7 +3179,7 @@ export declare type Sequence = {
   createSetInPointAction(tickTime: TickTime): Action;
 
   /**
-   * Create an action to set an InPoint for the sequence
+   * Create an action to set the zero point for the sequence.
    *
    * @param tickTime
    */
@@ -4344,6 +4369,49 @@ export declare type VideoTransitionStatic = {
 
 export declare type VideoTransition = {};
 
+export declare type WorkAreaUtilsStatic = {
+  /**
+   * Get the work area in point of the sequence.
+   *
+   * @param sequence
+   */
+  getWorkAreaInPoint(sequence: Sequence): TickTime;
+
+  /**
+   * Get the work area out point of the sequence.
+   *
+   * @param sequence
+   */
+  getWorkAreaOutPoint(sequence: Sequence): TickTime;
+
+  /**
+   * Set the work area in point of the sequence.
+   *
+   * @param sequence
+   * @param tickTime
+   */
+  setWorkAreaInPoint(sequence: Sequence, tickTime: TickTime): boolean;
+
+  /**
+   * Set the work area out point of the sequence.
+   *
+   * @param sequence
+   * @param tickTime
+   */
+  setWorkAreaOutPoint(sequence: Sequence, tickTime: TickTime): boolean;
+
+  /**
+   * Set the work area in and out points of the sequence.
+   *
+   * @param sequence
+   * @param inTickTime
+   * @param outTickTime
+   */
+  setWorkAreaInOutPoints(sequence: Sequence, inTickTime: TickTime, outTickTime: TickTime): boolean;
+};
+
+export declare type WorkAreaUtils = {};
+
 export declare type EventManagerStatic = {
   /**
    * add event listener to target object
@@ -4444,6 +4512,13 @@ export declare type TranscriptStatic = {
    */
   querySupportedLanguages(): Array<{ displayString: string; languageCode: string; locale: string }>;
 
+  /**
+   * Returns true if the language pack for the given language code is available ex:isLanguagePackAvailable('en-US')
+   *
+   * @param language
+   */
+  isLanguagePackAvailable(language: string): boolean;
+
   /**
    * Returns true if the ClipProjectItem has an existing transcript
    *
@@ -4462,6 +4537,9 @@ export declare type TranscriptStatic = {
 export declare type Transcript = {};
 
 export namespace Constants {
+  /**
+   * @since 26.3
+   */
   export enum AAFExportAudioFormat {
     AIFF,
     WAV,
@@ -4514,10 +4592,22 @@ export namespace Constants {
     TIME_TRANSITION_START,
   }
 
+  /**
+   * @since 25.6
+   */
   export enum MarkerColor {
     GREEN,
     RED,
+    /**
+     * @since 25.6
+     * @since 26.5 Deprecated in favor of the properly spelled 'MAGENTA' equivalent.
+     * @deprecated Use MAGENTA instead.
+     */
     MAGNETA,
+    /**
+     * @since 26.5
+     */
+    MAGENTA,
     ORANGE,
     YELLOW,
     BLUE,