/* * Copyright 2026 Adobe. All rights reserved. * * This file is licensed to you under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. You may obtain a copy * of the License at http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software distributed under * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS * OF ANY KIND, either express or implied. See the License for the specific language * governing permissions and limitations under the License. */ export declare type premierepro = { AAFExportOptions: AAFExportOptionsStatic; Action: Action; AddTransitionOptions: AddTransitionOptionsStatic; AppPreference: AppPreferenceStatic; Application: Application; AudioClipTrackItem: AudioClipTrackItemStatic; AudioComponentChain: AudioComponentChainStatic; AudioFilterComponent: AudioFilterComponentStatic; AudioFilterFactory: AudioFilterFactoryStatic; AudioTrack: AudioTrackStatic; C2PAService: C2PAServiceStatic; CaptionTrack: CaptionTrackStatic; ClipProjectItem: ClipProjectItemStatic; CloseProjectOptions: CloseProjectOptionsStatic; Color: ColorStatic; Component: Component; ComponentParam: ComponentParam; CompoundAction: CompoundAction; EncoderManager: EncoderManagerStatic; Exporter: ExporterStatic; FolderItem: FolderItemStatic; FootageInterpretation: FootageInterpretation; FrameRate: FrameRateStatic; Guid: GuidStatic; IngestSettings: IngestSettings; Keyframe: KeyframeStatic; Marker: MarkerStatic; Markers: MarkersStatic; Media: Media; MediaManager: MediaManagerStatic; Metadata: MetadataStatic; ObjectMaskUtils: ObjectMaskUtilsStatic; OpenProjectOptions: OpenProjectOptionsStatic; OperationCompleteEvent: OperationCompleteEventStatic; PRProduction: PRProductionStatic; PointF: PointFStatic; PointKeyframe: PointKeyframe; Project: ProjectStatic; ProjectClosedEvent: ProjectClosedEventStatic; ProjectColorSettings: ProjectColorSettings; ProjectConverter: ProjectConverterStatic; ProjectEvent: ProjectEventStatic; ProjectItem: ProjectItemStatic; ProjectItemSelection: ProjectItemSelection; ProjectSettings: ProjectSettingsStatic; ProjectUtils: ProjectUtilsStatic; Properties: PropertiesStatic; RectF: RectFStatic; ScratchDiskSettings: ScratchDiskSettingsStatic; Sequence: SequenceStatic; SequenceEditor: SequenceEditorStatic; SequenceSettings: SequenceSettingsStatic; SequenceUtils: SequenceUtilsStatic; SnapEvent: SnapEventStatic; SourceMonitor: SourceMonitorStatic; TextSegments: TextSegmentsStatic; TickTime: TickTimeStatic; TimeDisplay: TimeDisplay; TrackItemSelection: TrackItemSelectionStatic; TransitionFactory: TransitionFactoryStatic; UniqueSerializeable: UniqueSerializeableStatic; Utils: UtilsStatic; VideoClipTrackItem: VideoClipTrackItemStatic; VideoComponentChain: VideoComponentChainStatic; VideoFilterComponent: VideoFilterComponentStatic; VideoFilterFactory: VideoFilterFactoryStatic; VideoTrack: VideoTrackStatic; VideoTransition: VideoTransitionStatic; WorkAreaUtils: WorkAreaUtilsStatic; EventManager: EventManagerStatic; Transcript: TranscriptStatic; Constants: typeof Constants; }; export declare type AAFExportOptionsStatic = { /** * Construct an object that contains properties for AAF export. * @constructor */ new (): AAFExportOptions; (): AAFExportOptions; }; export declare type AAFExportOptions = { /** * Set the audio file format (0 for AIFF, 1 for WAV) * * @param audioFileFormat */ setAudioFileFormat(audioFileFormat: Constants.AAFExportAudioFormat): AAFExportOptions; /** * Set the audio bits per sample * * @param bitsPerSample */ setBitsPerSample(bitsPerSample: number): AAFExportOptions; /** * Set whether to embed audio in the AAF file * * @param embedAudio */ setEmbedAudio(embedAudio: boolean): AAFExportOptions; /** * When true, exports multichannel audio as separate mono media files (one file per channel) * * @param explodeToMono */ setExplodeToMono(explodeToMono: boolean): AAFExportOptions; /** * Set the number of handle frames * * @param handleFrames */ setHandleFrames(handleFrames: number): AAFExportOptions; /** * Set whether to interleave without effects * * @param interleaveWithoutEffects */ setInterleaveWithoutEffects(interleaveWithoutEffects: boolean): AAFExportOptions; /** * When true, renders the sequence video to a single media file for AAF export (video mixdown) instead of relying only on linked source clips * * @param mixdownVideo */ setMixdownVideo(mixdownVideo: boolean): AAFExportOptions; /** * When true, exploded mono audio is written under a subdirectory named after the folder that contained each clip's source media on disk * * @param preserveParentFolder */ setPreserveParentFolder(preserveParentFolder: boolean): AAFExportOptions; /** * Set whether to render audio effects * * @param renderAudioEffects */ setRenderAudioEffects(renderAudioEffects: boolean): AAFExportOptions; /** * Set the audio sample rate * * @param sampleRate */ setSampleRate(sampleRate: number): AAFExportOptions; /** * Set whether to trim sources * * @param trimSources */ setTrimSources(trimSources: boolean): AAFExportOptions; /** * Path to the encoder preset file (.epr) used when mixdown video is enabled * * @param videoMixdownPresetPath */ setVideoMixdownPresetPath(videoMixdownPresetPath: string): AAFExportOptions; /** * Get the audio file format (0 for AIFF, 1 for WAV) * @readonly */ readonly audioFileFormat: number; /** * Get the audio bits per sample * @readonly */ readonly bitsPerSample: number; /** * Get whether to embed audio in the AAF file * @readonly */ readonly embedAudio: boolean; /** * True if multichannel audio is exported as separate mono files per channel * @readonly */ readonly explodeToMono: boolean; /** * Get the number of handle frames * @readonly */ readonly handleFrames: number; /** * Get whether to interleave without effects * @readonly */ readonly interleaveWithoutEffects: boolean; /** * True if the exporter will render a single mixed-down video file * @readonly */ readonly mixdownVideo: boolean; /** * Get whether to preserve parent folder * @readonly */ readonly preserveParentFolder: boolean; /** * Get whether to render audio effects * @readonly */ readonly renderAudioEffects: boolean; /** * Get the audio sample rate * @readonly */ readonly sampleRate: number; /** * Get whether to trim sources * @readonly */ readonly trimSources: boolean; /** * Get the video mixdown preset path * @readonly */ readonly videoMixdownPresetPath: string; }; export declare type Action = {}; export declare type AddTransitionOptionsStatic = { /** * Construct an object that contains properties for applying transition. * @constructor */ new (): AddTransitionOptions; (): AddTransitionOptions; }; export declare type AddTransitionOptions = { /** * Set whether to apply transition to the start or end of trackitem * * @param applyToStart */ setApplyToStart(applyToStart: boolean): AddTransitionOptions; /** * Sets the duration of transition * * @param tickTime Sets the duration of transition in TickTime */ setDuration(tickTime: TickTime): AddTransitionOptions; /** * Set whether transition should be applied to one/both sides * * @param forceSingleSided */ setForceSingleSided(forceSingleSided: boolean): AddTransitionOptions; /** * Sets the transitionAlignment of the transition * * @param transitionAlignment */ setTransitionAlignment(transitionAlignment: number): AddTransitionOptions; /** * Get whether to apply transition to the start or end of trackitem * @readonly */ readonly applyToStart: boolean; /** * Gets the duration of transition * @readonly */ readonly duration: TickTime; /** * Get whether transition should be applied to one/both sides * @readonly */ readonly forceSingleSided: boolean; /** * Gets the transitionAlignment of transition * @readonly */ readonly transitionAlignment: number; }; export declare type AppPreferenceStatic = { /** * Get preference value in native string form * * @param preferenceKey App preference key to get */ getValue(preferenceKey: Constants.PreferenceKey): string; /** * 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 * @param persistenceFlag Indicates whether the preference should be persisted or not */ setValue( key: Constants.PreferenceKey, value: boolean | string | number, persistenceFlag: Constants.PropertyType ): boolean; /** * Preference string key used to modify auto-peak generation settings * @readonly */ readonly KEY_AUTO_PEAK_GENERATION: string; /** * Preference string key used to modify import workspace settings * @readonly */ readonly KEY_IMPORT_WORKSPACE: string; /** * Preference string key used to modify show quickstart dialog settings * @readonly */ readonly KEY_SHOW_QUICKSTART_DIALOG: string; /** * Property is not persisted and will be cleared when the project closes. * @readonly */ readonly PROPERTY_NON_PERSISTENT: number; /** * Property is persistent in backend and shared across cloud project. * @readonly */ readonly PROPERTY_PERSISTENT: number; }; export declare type AppPreference = {}; export declare type Application = { /** * @readonly */ readonly version: Promise; }; export declare type AudioClipTrackItemStatic = { /** * Clip Track Item Type * @readonly */ readonly TRACKITEMTYPE_CLIP: number; /** * Empty Track Item Type * @readonly */ readonly TRACKITEMTYPE_EMPTY: number; /** * Feedback Track Item Type * @readonly */ readonly TRACKITEMTYPE_FEEDBACK: number; /** * Previe Track Item Type * @readonly */ readonly TRACKITEMTYPE_PREVIEW: number; /** * Transition Track Item Type * @readonly */ readonly TRACKITEMTYPE_TRANSITION: number; }; export declare type AudioClipTrackItem = { /** * Returns an action that moves the inPoint of the track item to a new time, by shifting it by a number of seconds. * * @param tickTime */ createMoveAction(tickTime: TickTime): Action; /** * Returns an action that enables/disables the trackItem * * @param disabled */ createSetDisabledAction(disabled: boolean): Action; /** * Create set end time action for sequence * * @param tickTime */ createSetEndAction(tickTime: TickTime): Action; /** * Create SetInPointAction for setting the track item in point relative to the start time of the project item referenced by this track item * * @param tickTime Sets the In-Point in TickTime */ createSetInPointAction(tickTime: TickTime): Action; /** * Returns an action that renames the trackItem * * @param inName */ createSetNameAction(inName: string): Action; /** * Create SetOutPointAction for setting the track item out point relative to the start time of the project item referenced by this track item * * @param tickTime Sets the Out-Point in TickTime */ createSetOutPointAction(tickTime: TickTime): Action; /** * Create set start time action for sequence * * @param tickTime */ createSetStartAction(tickTime: TickTime): Action; /** * Returns timecode representing the duration of this track item relative to the sequence start. */ getDuration(): Promise; /** * Returns a TickTime object representing the ending sequence time of this track item relative to the sequence start time. */ getEndTime(): Promise; /** * Returns a TickTime object representing the track item in point relative to the start time of the project item referenced by this track item. */ getInPoint(): Promise; /** * Returns if trackItem is selected or not */ getIsSelected(): Promise; /** * Returns the value of internal matchname for this trackItem */ getMatchName(): Promise; /** * Returns UUID representing the underlying media type of this track item */ getMediaType(): Promise; /** * Returns the display name for trackItem */ getName(): Promise; /** * Returns a TickTime object representing the track item out point relative to the start time of the project item referenced by this track item. */ getOutPoint(): Promise; /** * Returns the project item for this track item. */ getProjectItem(): Promise; /** * Returns the value of speed of the trackItem */ getSpeed(): Promise; /** * Returns a TickTime object representing the starting sequence time of this track item relative to the sequence start time. */ getStartTime(): Promise; /** * Index representing the track index of the track this track item belongs to */ getTrackIndex(): Promise; /** * Index representing the type of this track item. */ getType(): Promise; /** * Returns true if the trackitem is an adjustment layer */ isAdjustmentLayer(): Promise; /** * Returns true if trackitem is muted/disabled */ isDisabled(): Promise; /** * Returns true if the trackitem is reversed */ isSpeedReversed(): Promise; /** * Returns AudioComponentChain */ getComponentChain(): Promise; }; export declare type AudioComponentChainStatic = {}; export declare type AudioComponentChain = { /** * Creates and returns an append component action * * @param component Audio filter component */ createAppendComponentAction(component: Component | AudioFilterComponent): Action; /** * Creates and returns an insert component action * * @param component Audio filter component * @param componentInsertionIndex Index which the component shall be inserted */ createInsertComponentAction( component: Component | AudioFilterComponent, componentInsertionIndex: number ): Action; /** * Creates and returns an remove component action * * @param component Audio filter component */ createRemoveComponentAction(component: Component | AudioFilterComponent): Action; /** * Returns the component at the given index * * @param componentIndex * @returns Returns the component at the given index */ getComponentAtIndex(componentIndex: number): Component; /** * Gets the number of components in the component chain */ getComponentCount(): number; }; export declare type AudioFilterComponentStatic = {}; export declare type AudioFilterComponent = {}; export declare type AudioFilterFactoryStatic = { /** * Creates a new audio filter component based on the input display name and trackItem for applying the audio filter * * @param displayName * @param inAudioClipTrackItem */ createComponentByDisplayName( displayName: string, inAudioClipTrackItem: AudioClipTrackItem ): Promise; /** * Returns an array of audio filter displayNames */ getDisplayNames(): Promise; }; export declare type AudioFilterFactory = {}; export declare type AudioTrackStatic = { /** * Event Object for Track changed * @readonly */ readonly EVENT_TRACK_CHANGED: string; /** * Event Object for Track Info Changed * @readonly */ readonly EVENT_TRACK_INFO_CHANGED: string; /** * Event Object for Track Lock Changed * @readonly */ readonly EVENT_TRACK_LOCK_CHANGED: string; }; export declare type AudioTrack = { /** * Action to change the name of the track * * @param name */ createSetNameAction(name: string): Action; /** * Index representing the track index of this track within the track group. */ getIndex(): Promise; /** * UUID representing the underlying media type of this track */ getMediaType(): Promise; /** * Get mute state of the track */ isMuted(): Promise; /** * sets the mute state of the track to muted/unmuted * * @param mute */ setMute(mute: boolean): Promise; /** * Returns array of AudioClipTrackItem from the track item type * * @param trackItemType Constants.TrackItemType.CLIP, Constants.TrackItemType.TRANSITION etc.. * @param includeEmptyTrackItems */ getTrackItems( trackItemType: Constants.TrackItemType, includeEmptyTrackItems: boolean ): AudioClipTrackItem[]; /** * The ID of the track within the TrackGroup * @readonly */ readonly id: number; /** * Get the name of the track * @readonly */ readonly name: string; }; export declare type C2PAServiceStatic = { /** * Returns an object with 'manifest' (JSON string) and 'manifestLocation' (number) indicating where the C2PA manifest was found. Location flags: NONE (0), EMBEDDED (1), SIDE_CAR (2), CLOUD (4). If withValidation is true, the file will be validated during processing. * * @param filePath * @param withValidation */ getManifest( filePath: string, withValidation: boolean ): { manifest: string; manifestLocation: Constants.C2PAManifestLocation }; /** * Content credentials CLOUD * @readonly */ readonly MANIFEST_LOCATION_CLOUD: number; /** * Content credentials EMBEDDED * @readonly */ readonly MANIFEST_LOCATION_EMBEDDED: number; /** * Content credentials NONE * @readonly */ readonly MANIFEST_LOCATION_NONE: number; /** * Content credentials SIDE_CAR * @readonly */ readonly MANIFEST_LOCATION_SIDE_CAR: number; }; export declare type C2PAService = {}; export declare type CaptionTrackStatic = {}; export declare type CaptionTrack = { /** * Action to change the name of the track * * @param name */ createSetNameAction(name: string): Action; /** * Index representing the track index of this track within the track group. */ getIndex(): Promise; /** * UUID representing the underlying media type of this track */ getMediaType(): Promise; /** * Get mute state of the track */ isMuted(): Promise; /** * sets the mute state of the track to muted/unmuted * * @param mute */ setMute(mute: boolean): Promise; /** * Returns the track items of the specified media type from the given track * * @param trackItemType * @param includeEmptyTrackItems */ getTrackItems(trackItemType: number, includeEmptyTrackItems: boolean): []; /** * The ID of the track within the TrackGroup * @readonly */ readonly id: number; /** * Get the name of the track * @readonly */ readonly name: string; }; export declare type ClipProjectItemStatic = { /** * Cast ProjectItem in to ClipProjectItem * * @param projectItem */ cast(projectItem: ProjectItem): ClipProjectItem; }; export declare type ClipProjectItem = { /** * Attach proxy or high resolution footage to projectItem and returns true if successful. Not undoable. * * @param mediaPath * @param isHiRes * @param inMakeAlternateLinkInTeamProjects */ attachProxy( mediaPath: string, isHiRes: boolean, inMakeAlternateLinkInTeamProjects?: boolean ): Promise; /** * Returns true if Premiere Pro can change the path associated with this project item; otherwise, returns false */ canChangeMediaPath(): Promise; /** * Indicates whether it is possible to attach a proxy to this project item. */ canProxy(): Promise; /** * Change media file path of projectItem and returns true if successful. Not undoable. * * @param newPath * @param overrideCompatibilityCheck */ changeMediaFilePath(newPath: string, overrideCompatibilityCheck?: boolean): Promise; /** * Set the footage interpretation object for project item * * @param footageInterpretation */ createSetFootageInterpretationAction(footageInterpretation: FootageInterpretation): Action; /** * Create action for setting Guid of Input LUT on media. This applies for Video Clips only. * * @param stringLUTID */ createSetInputLUTIDAction(stringLUTID: string): Action; /** * Returns an action which sets the media offline */ createSetOfflineAction(): Action; /** * Returns an action which sets the scale to frame to true */ createSetScaleToFrameSizeAction(): Action; /** * 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 * @param endTime * @param hasHardBoundaries * @param options */ createSubClipAction( name: string, startTime: TickTime, endTime: TickTime, hasHardBoundaries: boolean, options?: { takeVideo?: boolean; takeAudio?: boolean } ): Action; /** * Returns array of project's items with media paths containing match string * * @param matchString * @param ignoreSubclips */ findItemsMatchingMediaPath(matchString: string, ignoreSubclips?: boolean): Promise; /** * Get GUID of LUT embedded in media */ getEmbeddedLUTID(): Promise; /** * Get the footage interpretation object for project item */ getFootageInterpretation(): Promise; /** * Get Guid of Input LUT overridden on media */ getInputLUTID(): Promise; /** * Returns the proxy path if the project item has a proxy attached */ getProxyPath(): Promise; /** * Indicates whether a proxy has already been attached to the project item. */ hasProxy(): Promise; /** * Returns true if the clip Project item is a merged clip */ isMergedClip(): Promise; /** * Returns true if the clip Project item is a multicam clip */ isMulticamClip(): Promise; /** * Returns true if the media is offline */ isOffline(): Promise; /** * Returns true if the project item is a sequence */ isSequence(): Promise; /** * Updates representation of the media associated with the project item */ refreshMedia(): Promise; /** * Create an action for set color label to projectItem by index * * @param inColorLabelIndex */ createSetColorLabelAction(inColorLabelIndex: number): Action; /** * Returns action that renames projectItem * * @param inName */ createSetNameAction(inName: string): Action; /** * Get color label index of projectItem */ getColorLabelIndex(): Promise; /** * Get the parent Project of this projectItem. */ getProject(): Promise; /** * Get content type of the Project item */ getContentType(): Promise; /** * Get the sequence of the Project item */ getSequence(): Promise; /** * Get the in point of the Project item * * @param mediaType Media type can be audio, video or data/caption */ getInPoint(mediaType: Constants.MediaType): Promise; /** * Get the out point of the Project item * * @param mediaType Media type can be audio, video or data/caption */ getOutPoint(mediaType: Constants.MediaType): Promise; /** * Get the media file path of the Project item. */ getMediaFilePath(): Promise; /** * Get the component chain of the Project item for the given media type. * * @param mediaType Media type can be audio or video */ getComponentChain( mediaType: Constants.MediaType ): Promise; /** * Returns an action which Sets the in point of the Project item * * @param tickTime */ createSetInPointAction(tickTime: TickTime): Action; /** * Returns an action which sets Override pixel aspect ratio * * @param numerator * @param denominator */ createSetOverridePixelAspectRatioAction(numerator: number, denominator: number): Action; /** * Returns an action which sets the override frame rate * * @param overriddenFrameRateValue */ createSetOverrideFrameRateAction(overriddenFrameRateValue: number): Action; /** * Returns an action which Sets the in point of the Project item * * @param tickTime */ createSetOutPointAction(tickTime: TickTime): Action; /** * Set the in or out point of the Project item * * @param inPoint * @param outPoint */ createSetInOutPointsAction(inPoint: TickTime, outPoint: TickTime): Action; /** * Create Clear the in or out point of the Project item action */ createClearInOutPointsAction(): Action; /** * Return media associated with clipProjectItem */ getMedia(): Promise; /** * Return originating project path associated with clipProjectItem */ getOriginatingProjectPath(): Promise; /** * The name of this project item. * @readonly */ readonly name: string; /** * Get the type of the Project Item. * @readonly */ readonly type: number; }; export declare type CloseProjectOptionsStatic = { /** * Construct an object that contains properties for closing a project. * @constructor */ new (): CloseProjectOptions; (): CloseProjectOptions; }; export declare type CloseProjectOptions = { /** * Set whether the app should be prepared to quit when open/closing a project * * @param isAppBeingPreparedToQuit */ setIsAppBeingPreparedToQuit(isAppBeingPreparedToQuit: boolean): CloseProjectOptions; /** * Set whether to prompt if a project is dirty on project open/close * * @param promptIfDirty */ setPromptIfDirty(promptIfDirty: boolean): CloseProjectOptions; /** * Set whether to save your workspaces when opening/closing a project * * @param isAppBeingPreparedToQuit */ setSaveWorkspace(isAppBeingPreparedToQuit: boolean): CloseProjectOptions; /** * Set whether to show the cancel button on project open/close * * @param showCancelButton */ setShowCancelButton(showCancelButton: boolean): CloseProjectOptions; /** * Get whether the app is prepared to quit when open/closing a project * @readonly */ readonly isAppBeingPreparedToQuit: boolean; /** * Get whether a prompt is shown if a project is dirty on project open/close * @readonly */ readonly promptIfDirty: boolean; /** * Get whether your workspaces are saved when opening/closing a project * @readonly */ readonly saveWorkspace: boolean; /** * Get whether the cancel button is shown on project open/close * @readonly */ readonly showCancelButton: boolean; }; export declare type ColorStatic = { /** * Construct a Color Object with parameters for Red, Green, Blue, and Alpha values which are in range [0.0-1.0] * @constructor * * @param [red] * @param [green] * @param [blue] * @param [alpha] */ new (red?: number, green?: number, blue?: number, alpha?: number): Color; (red?: number, green?: number, blue?: number, alpha?: number): Color; }; export declare type Color = { /** * Returns true if the given ColorObject is equal to this ColorObject * * @param colorObject */ equals(colorObject: Color): boolean; /** * Read/Write property to get/set alpha value of color object */ alpha: number; /** * Read/Write property to get/set blue value of color object */ blue: number; /** * Read/Write property to get/set green value of color object */ green: number; /** * Read/Write property to get/set red value of color object */ red: number; }; export declare type Component = { /** * Returned Promise will be fullfilled with the value of display name for this component */ getDisplayName(): Promise; /** * Returned Promise will be fullfilled with the value of internal matchname for this component */ getMatchName(): Promise; /** * 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. * * @param paramIndex */ getParam(paramIndex?: number): ComponentParam; /** * Gets the number of param in the component */ getParamCount(): number; }; export declare type ComponentParam = { /** * Returns bool whether keyframes are supported for this component parameter */ areKeyframesSupported(): Promise; /** * Creates and returns an action object which can be used to add a keyframe component * * @param inKeyFrame */ createAddKeyframeAction(inKeyFrame: Keyframe): Action; /** * 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 * * @param inValue Input could be number, string, boolean, PointF, or Color depend on effect param type */ createKeyframe(inValue: number | string | boolean | PointF | Color): Keyframe; /** * Returns an action which removes keyframe at specific time * * @param inTime * @param UpdateUI */ createRemoveKeyframeAction(inTime: TickTime, UpdateUI?: boolean): Action; /** * Returns an action which removes keyframe at specific time range * * @param inTime * @param outTime * @param UpdateUI */ createRemoveKeyframeRangeAction(inTime: TickTime, outTime: TickTime, UpdateUI?: boolean): Action; /** * Returns an action which sets the interpolation mode of keyframe at the given time * * @param inTime * @param InterpolationMode * @param UpdateUI */ createSetInterpolationAtKeyframeAction( inTime: TickTime, InterpolationMode: number, UpdateUI?: boolean ): Action; /** * Creates and returns an action object to set the component to be time varying * * @param inTimeVarying */ createSetTimeVaryingAction(inTimeVarying: boolean): Action; /** * Creates and returns an action object which can be used to set the value of a non-time varying component * * @param inKeyFrame * @param inSafeForPlayback */ createSetValueAction(inKeyFrame: Keyframe, inSafeForPlayback?: boolean): Action; /** * Find sthe nearest key for the given time * * @param inTime * @param outTime */ findNearestKeyframe(inTime: TickTime, outTime: TickTime): Keyframe; /** * find the next keyframe for the given time * * @param inTime */ findNextKeyframe(inTime: TickTime): Keyframe; /** * find the previous keyframe for the given time * * @param inTime */ findPreviousKeyframe(inTime: TickTime): Keyframe; /** * Get a list of tickTime for the keyframes of this component param */ getKeyframeListAsTickTimes(): TickTime[]; /** * Get the Keyframe at the given tickTime postion * * @param time */ getKeyframePtr(time?: TickTime): Keyframe; /** * Returned promise will be fullfilled with the start value (keyframe) of the component param */ getStartValue(): Promise; /** * Gets the value of component Param at the given time * * @param time The time at which to get the value of the component param */ getValueAtTime(time: TickTime): Promise; /** * Returns true if the parameter value varies over time (for the duration of the item) */ isTimeVarying(): boolean; /** * Returns the display name of the component param * @readonly */ readonly displayName: string; }; export declare type CompoundAction = { /** * Add an action to the compound action * * @param action */ addAction(action: Action): boolean; /** * Is the compound action empty? * @readonly */ readonly empty: boolean; }; export declare type EncoderManagerStatic = { /** * Get the Export File Extension of Input Preset file * * @param sequence * @param presetFilePath */ getExportFileExtension(sequence: Sequence, presetFilePath: string): Promise; /** * Get the Encoder Manager object. */ getManager(): EncoderManager; /** * Broadcast when AME job is canceled * @readonly */ readonly EVENT_RENDER_CANCEL: string; /** * Broadcast when AME is finished rendering * @readonly */ readonly EVENT_RENDER_COMPLETE: string; /** * Broadcast when AME gives back error message * @readonly */ readonly EVENT_RENDER_ERROR: string; /** * Broadcast when AME job is rendering the job * @readonly */ readonly EVENT_RENDER_PROGRESS: string; /** * Broadcast when AME job is queued * @readonly */ readonly EVENT_RENDER_QUEUE: string; /** * Export type used to immediately exporting an object * @readonly */ readonly EXPORT_IMMEDIATELY: string; /** * Export type used to queue an export job into the Adobe Media Encoder export queue * @readonly */ readonly EXPORT_QUEUE_TO_AME: string; /** * Export type used to queue an export job into the app export queue * @readonly */ readonly EXPORT_QUEUE_TO_APP: string; }; export declare type EncoderManager = { /** * Encode input media file in AME * * @param filePath * @param outputFile * @param presetFile * @param inPoint * @param outPoint * @param workArea * @param removeUponCompletion * @param startQueueImmediately */ encodeFile( filePath: string, outputFile?: string, presetFile?: string, inPoint: TickTime, outPoint: TickTime, workArea?: number, removeUponCompletion?: boolean, startQueueImmediately?: boolean ): Promise; /** * Encode input clipProjectItem in AME * * @param clipProjectItem * @param outputFile * @param presetFile * @param workArea * @param removeUponCompletion * @param startQueueImmediately */ encodeProjectItem( clipProjectItem: ClipProjectItem, outputFile?: string, presetFile?: string, workArea?: number, removeUponCompletion?: boolean, startQueueImmediately?: boolean ): Promise; /** * 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. * * @param sequence * @param exportType Constants.ExportType.IMMEDIATELY, Constants.ExportType.QUEUE_TO_AME etc.. * @param outputFile * @param presetFile * @param exportFull */ exportSequence( sequence: Sequence, exportType: Constants.ExportType, outputFile?: string, presetFile?: string, exportFull?: boolean ): Promise; /** * Launch AME asynchronously if not already running. */ launchEncoder(): Promise; /** * Set whether to enable embedded XMP when exporting a sequence. * * @param enabled */ setEmbeddedXMPEnabled(enabled: boolean): Promise; /** * Set whether to enable sidecar XMP when exporting a sequence. * * @param enabled */ setSidecarXMPEnabled(enabled: boolean): Promise; /** * Start encoding the AME batch queue. */ startBatchEncode(): Promise; /** * Check if AME is installed. * @readonly */ readonly isAMEInstalled: boolean; }; export declare type ExporterStatic = { /** * Exports from a sequence. Supported formats are bmp, dpx, gif, jpg, exr, png, tga and tif * * @param sequence * @param time * @param filename Filename to be exported , example 'C:/temp/exportedFrame.png' * @param filepath Directory to be exported, example 'C:/temp/' * @param width * @param height */ exportSequenceFrame( sequence: Sequence, time: TickTime, filename: string, filepath: string, width: number, height: number ): Promise; }; export declare type Exporter = {}; export declare type FolderItemStatic = { /** * Cast ProjectItem in to FolderItem * * @param projectItem */ cast(projectItem: ProjectItem): FolderItem; }; export declare type FolderItem = { /** * Returns an action that lets users create a new bin. * * @param name * @param makeUnique */ createBinAction(name: string, makeUnique: boolean): Action; /** * Creates an action that moves the given item to the provided folder item newParent. * * @param item * @param newParent */ createMoveItemAction(item: ProjectItem, newParent: FolderItem): Action; /** * Creates an action that removes the given item from this folder. * * @param item */ createRemoveItemAction(item: ProjectItem): Action; /** * Rename the Bin and return true if it's successful * * @param name */ createRenameBinAction(name: string): Action; /** * Creates a smart bin with given name and returns the Folder object * * @param name * @param searchQuery */ createSmartBinAction(name: string, searchQuery: string): Action; /** * Collection of child items of this folder. */ getItems(): Promise; /** * Create an action for set color label to projectItem by index * * @param inColorLabelIndex */ createSetColorLabelAction(inColorLabelIndex: number): Action; /** * Returns action that renames projectItem * * @param inName */ createSetNameAction(inName: string): Action; /** * Get color label index of projectItem */ getColorLabelIndex(): Promise; /** * Get the parent Project of this projectItem. */ getProject(): Promise; /** * The name of this project item. * @readonly */ readonly name: string; /** * Get the type of the Project Item. * @readonly */ readonly type: number; }; export declare type FootageInterpretation = { /** * Get alpha usage type property of footage */ getAlphaUsage(): number; /** * Get field type of footage */ getFieldType(): number; /** * Get frame rate of footage */ getFrameRate(): number; /** * Get ignore alpha property of footage */ getIgnoreAlpha(): boolean; /** * Get input LUTID of footage */ getInputLUTID(): string; /** * Get invert alpha property of footage */ getInvertAlpha(): boolean; /** * Get pixel aspect ratio of footage */ getPixelAspectRatio(): number; /** * Get removePullDown property of footage */ getRemovePullDown(): boolean; /** * Get vr conform projection type of footage */ getVrConform(): number; /** * Get vr horizontal view of footage */ getVrHorzView(): number; /** * Get vr layout type of footage */ getVrLayout(): number; /** * Get vr vertical view of footage */ getVrVertView(): number; /** * Set alpha usage type property of footage * * @param alphaUsage */ setAlphaUsage(alphaUsage: number): boolean; /** * Set field type of footage * * @param fieldType */ setFieldType(fieldType: number): boolean; /** * Set frame rate of footage * * @param frameRate */ setFrameRate(frameRate: number): boolean; /** * Set ignore alpha property of footage * * @param ignoreAlpha */ setIgnoreAlpha(ignoreAlpha: boolean): boolean; /** * Set input LUTID of footage * * @param inputLUTID */ setInputLUTID(inputLUTID: string): boolean; /** * Set invert alpha property of footage * * @param invertAlpha */ setInvertAlpha(invertAlpha: boolean): boolean; /** * Set pixel aspect ratio of footage * * @param pixelAspectRatio */ setPixelAspectRatio(pixelAspectRatio: number): boolean; /** * Set removePullDown property of footage * * @param removePulldown */ setRemovePullDown(removePulldown: boolean): boolean; /** * Set vr conform projection type of footage * * @param vrConform */ setVrConform(vrConform: number): boolean; /** * Set vr horizontal view of footage * * @param vrHorzView */ setVrHorzView(vrHorzView: number): boolean; /** * Set vr layout type of footage * * @param vrLayOut */ setVrLayout(vrLayOut: number): boolean; /** * Set vr horizontal view of footage * * @param vrVertView */ setVrVertView(vrVertView: number): boolean; /** * alpha channel ignore * @readonly */ readonly ALPHACHANNEL_IGNORE: number; /** * alpha channel none * @readonly */ readonly ALPHACHANNEL_NONE: number; /** * alpha channel premultiplied * @readonly */ readonly ALPHACHANNEL_PREMULTIPLIED: number; /** * alpha channel straight * @readonly */ readonly ALPHACHANNEL_STRAIGHT: number; /** * default filed type invalid * @readonly */ readonly FIELD_TYPE_DEFAULT: number; /** * field type lowerfirst * @readonly */ readonly FIELD_TYPE_LOWERFIRST: number; /** * field type progressive * @readonly */ readonly FIELD_TYPE_PROGRESSIVE: number; /** * field type upperfirst * @readonly */ readonly FIELD_TYPE_UPPERFIRST: number; }; export declare type FrameRateStatic = { /** * Constructs a FrameRate object * @constructor */ new (): FrameRate; (): FrameRate; /** * Create frame rate object with a value * * @param value */ createWithValue(value: number): FrameRate; }; export declare type FrameRate = { /** * Returns true if the given FrameRate is equal to this FrameRate object * * @param frameRate */ equals(frameRate: FrameRate): boolean; /** * Read/Write property to get/set ticks per frame. */ ticksPerFrame: number; /** * Get the number of frames per second. * @readonly */ readonly value: number; }; export declare type GuidStatic = { /** * Constructs an empty Guid object * @constructor */ new (): Guid; (): Guid; /** * Create a guid from a string * * @param stringValue */ fromString(stringValue: string): Guid; }; export declare type Guid = { /** * Return string representation of the GUID */ toString(): string; }; export declare type IngestSettings = { /** * Get whether or not ingest is enabled */ getIsIngestEnabled(): Promise; /** * Set whether or not ingest is enabled * * @param enabled */ setIngestEnabled(enabled: boolean): Promise; }; export declare type KeyframeStatic = { /** * Bezier interpolation mode * @readonly */ readonly INTERPOLATION_MODE_BEZIER: number; /** * Hold interpolation mode * @readonly */ readonly INTERPOLATION_MODE_HOLD: number; /** * Linear interpolation mode * @readonly */ readonly INTERPOLATION_MODE_LINEAR: number; /** * Time interpolation mode * @readonly */ readonly INTERPOLATION_MODE_TIME: number; /** * Time transition end interpolation mode * @readonly */ readonly INTERPOLATION_MODE_TIME_TRANSITION_END: number; /** * Time transition start interpolation mode * @readonly */ readonly INTERPOLATION_MODE_TIME_TRANSITION_START: number; }; export declare type Keyframe = { /** * Gets temporal interpolation mode of a keyframe */ getTemporalInterpolationMode(): Promise; /** * Sets temporal interpolation mode of a keyframe * * @param temporalInterpolationMode */ setTemporalInterpolationMode(temporalInterpolationMode: number): Promise; /** * Get/Set position of a keyframe */ position: TickTime; /** */ value: { value: string | number | boolean | Color | PointF }; }; export declare type MarkerStatic = { /** * Marker Type: Chapter * @readonly */ readonly MARKER_TYPE_CHAPTER: string; /** * Marker Type: Comment * @readonly */ readonly MARKER_TYPE_COMMENT: string; /** * Marker Type: FLVCuePoint * @readonly */ readonly MARKER_TYPE_FLVCUEPOINT: string; /** * Marker Type: WebLink * @readonly */ readonly MARKER_TYPE_WEBLINK: string; }; export declare type Marker = { /** * Return an action to set the color of the marker by the color index * * @param colorIndex */ createSetColorByIndexAction(colorIndex: number): Action; /** * Return an action to set the comments of the marker. * * @param comments */ createSetCommentsAction(comments: string): Action; /** * Return an action to set the duration of the marker. * * @param tickTime */ createSetDurationAction(tickTime: TickTime): Action; /** * Return an action to set the name of the marker. * * @param name */ createSetNameAction(name: string): Action; /** * Return an action to set the type of the marker. * * @param markerType Can be set to "Comment", "Chapter", "Segmentation", or "WebLink" */ createSetTypeAction(markerType: string): Action; /** * Get color code of the marker. */ getColor(): Color; /** * Get color index of the marker. */ getColorIndex(): number; /** * Get comments of the marker. */ getComments(): string; /** * Get duration time of the marker. */ getDuration(): TickTime; /** * Get name of the marker. */ getName(): string; /** * Get start time of the marker. */ getStart(): TickTime; /** * Get target of the marker. Used together with url for web targets. */ getTarget(): string; /** * Get type of the marker. e.g. Cue / Track / Subclip / Cart */ getType(): string; /** * Get url of the marker. */ getUrl(): string; /** * The unique identifier of the marker. * @readonly */ readonly guid: Guid; }; export declare type MarkersStatic = { /** * Returns the Markers object for Sequence Or ProjectItem * * @param markerOwnerObject */ getMarkers(markerOwnerObject: Sequence | ClipProjectItem): Promise; }; export declare type Markers = { /** * Add a new marker * * @param name * @param markerType * @param startTime * @param duration * @param comments */ createAddMarkerAction( name: string, markerType?: string, startTime?: TickTime, duration?: TickTime, comments?: string ): Action; /** * Move the given marker at new time value * * @param marker * @param tickTime */ createMoveMarkerAction(marker: Marker, tickTime: TickTime): Action; /** * Remove the given marker * * @param marker */ createRemoveMarkerAction(marker: Marker): Action; /** * Get all markers * * @param filters Marker Type Filter (Optional) */ getMarkers(filters?: string[]): Marker[]; }; export declare type Media = { /** * Returns action that set start of media * * @param time */ createSetStartAction(time: TickTime): Action; /** * Get the media duration. */ getDuration(): TickTime; /** * Get the media start time. */ getStart(): TickTime; /** * Get the media duration * @readonly * @deprecated Use getDuration() instead. */ readonly duration: Promise; /** * Get the media start time * @readonly * @deprecated Use getStart() instead. */ readonly start: Promise; }; export declare type MediaManagerStatic = { /** * Flush the media cache. */ purgeMediaCache(): Promise; }; export declare type MediaManager = {}; export declare type MetadataStatic = { /** * Add name and label property to project metadata schema * * @param name * @param label * @param type */ addPropertyToProjectMetadataSchema(name: string, label: string, type: number): Promise; /** * Get set project metadata action * * @param projectItem * @param metadata * @param updatedFields */ createSetProjectMetadataAction( projectItem: ProjectItem, metadata: string, updatedFields: string[] ): Action; /** * Get set project XMP metadata action * * @param projectItem * @param metadata */ createSetXMPMetadataAction(projectItem: ProjectItem, metadata: string): Action; /** * Get project column metadata from project item * * @param projectItem */ getProjectColumnsMetadata(projectItem: ProjectItem): Promise; /** * Get project metadata * * @param projectItem */ getProjectMetadata(projectItem: ProjectItem): Promise; /** * Get project panel metadata */ getProjectPanelMetadata(): Promise; /** * Get project XMP metadata * * @param projectItem */ getXMPMetadata(projectItem: ProjectItem): Promise; /** * Set project panel metadata * * @param metadata */ setProjectPanelMetadata(metadata: string): Promise; /** * Metadata Type: BOOLEAN * @readonly */ readonly METADATA_TYPE_BOOLEAN: number; /** * Metadata Type: INTEGER * @readonly */ readonly METADATA_TYPE_INTEGER: number; /** * Metadata Type: REAL * @readonly */ readonly METADATA_TYPE_REAL: number; /** * Metadata Type: TEXT * @readonly */ readonly METADATA_TYPE_TEXT: number; }; export declare type Metadata = {}; export declare type ObjectMaskUtilsStatic = { /** * Check if the project or sequence contains object mask. Returns true if at least one object mask exists. * * @param projectOrSequence */ hasObjectMask(projectOrSequence: Project | Sequence): boolean; }; export declare type ObjectMaskUtils = {}; export declare type OpenProjectOptionsStatic = { /** * Construct an object that contains properties for opening a project. * @constructor */ new (): OpenProjectOptions; (): OpenProjectOptions; }; export declare type OpenProjectOptions = { /** * Set whether to add to MRU list after project changes * * @param addToMRUList */ setAddToMRUList(addToMRUList: boolean): OpenProjectOptions; /** * Set whether to show the convert project dialog on project open/close * * @param showConvertProjectDialog */ setShowConvertProjectDialog(showConvertProjectDialog: boolean): OpenProjectOptions; /** * Set whether to show the locate file dialog on project open/close * * @param showLocateFileDialog */ setShowLocateFileDialog(showLocateFileDialog: boolean): OpenProjectOptions; /** * Set whether to show the warning file dialog on project open/close * * @param showConvertProjectDialog */ setShowWarningDialog(showConvertProjectDialog: boolean): OpenProjectOptions; /** * Get whether to add project changes to MRU list * @readonly */ readonly addToMRUList: boolean; /** * Get whether the convert project dialog is shown on project open/close * @readonly */ readonly showConvertProjectDialog: boolean; /** * Get whether locate file dialog is shown on project open/close * @readonly */ readonly showLocateFileDialog: boolean; /** * Get whether the warning file dialog is shown on project open/close * @readonly */ readonly showWarningDialog: boolean; }; export declare type OperationCompleteEventStatic = { /** * Event occurs when a clip reached its maximum extend limit. * @readonly */ readonly EVENT_CLIP_EXTEND_REACHED: string; /** * Event occurs when an effect is drag over a trackitem * @readonly */ readonly EVENT_EFFECT_DRAG_OVER: string; /** * Event occurs when an effect is dropped on a trackitem * @readonly */ readonly EVENT_EFFECT_DROP_COMPLETE: string; /** * Event occurs when a media export operation is complete. * @readonly */ readonly EVENT_EXPORT_MEDIA_COMPLETE: string; /** * Event occurs when a generative extend operation is complete. * @readonly */ readonly EVENT_GENERATIVE_EXTEND_COMPLETE: string; /** * Event occurs when a media import operation is complete. * @readonly */ readonly EVENT_IMPORT_MEDIA_COMPLETE: string; /** * Represents the state when an operation is cancelled. * @readonly */ readonly OPERATION_STATE_CANCELLED: number; /** * Represents the state when an operation is failed. * @readonly */ readonly OPERATION_STATE_FAILED: number; /** * Represents the state when an operation completes successfully. * @readonly */ readonly OPERATION_STATE_SUCCESS: number; }; export declare type OperationCompleteEvent = { /** * Indicates the outcome of a completed operation: Success, Cancelled, or Failed. * @readonly */ readonly state: number; }; export declare type PRProductionStatic = { /** * Get an instance of the currently active production. */ getActiveProduction(): PRProduction; }; export declare type PRProduction = { /** * Get the scratch disk settings instance for this production. */ getScratchDiskSettings(): Promise; }; export declare type PointFStatic = { /** * Construct a PointFloat Object. * @constructor * * @param [x] * @param [y] */ new (x?: number, y?: number): PointF; (x?: number, y?: number): PointF; }; export declare type PointF = { /** * Get the distance from one point to another point * * @param point */ distanceTo(point: PointF): number; /** * Get/Set the x value of a point */ x: number; /** * Get/Set the y value of a point */ y: number; }; export declare type PointKeyframe = { /** * Get/Set position of a keyframe */ position: TickTime; /** */ value: { value: PointF }; }; export declare type ProjectStatic = { /** * Create a new project * * @param path */ createProject(path: string): Promise; /** * Currently active project. */ getActiveProject(): Promise; /** * Get project referenced by given UID * * @param projectGuid */ getProject(projectGuid: Guid): Project; /** * Returns true if the file at the given path is openable as a Premiere project * * @param projectPath */ isProject(projectPath: string): boolean; /** * Open a project * * @param path * @param openProjectOptions */ open(path: string, openProjectOptions?: OpenProjectOptions): Promise; }; export declare type Project = { /** * Close a project * * @param closeProjectOptions */ close(closeProjectOptions?: CloseProjectOptions): Promise; /** * Close a sequence and return true if successful. * * @param sequence */ closeSequence(sequence: Sequence): Promise; /** * Create a new sequence with the default preset path - Parameter presetPath is deprecated, instead use createSequenceWithPresetPath() * * @param name * @param presetPath */ createSequence(name: string, presetPath?: string): Promise; /** * Create a new sequence with a given name and media * * @param name * @param clipProjectItems * @param targetBin */ createSequenceFromMedia( name: string, clipProjectItems?: ClipProjectItem[], targetBin?: ProjectItem ): Promise; /** * Create a new sequence with a preset path * * @param name * @param presetPath */ createSequenceWithPresetPath(name: string, presetPath: string): Promise; /** * Delete a given sequence from the project * * @param sequence */ deleteSequence(sequence: Sequence): Promise; /** * Get the active sequence of the project */ getActiveSequence(): Promise; /** * Get project color settings object */ getColorSettings(): Promise; /** * Get current insertion bin */ getInsertionBin(): Promise; /** * The root item of the project which contains all items of the project on the lowest level. */ getRootItem(): Promise; /** * Get sequence by id from the project * * @param guid */ getSequence(guid: Guid): Sequence; /** * Get an array of all sequences in this project. */ getSequences(): Promise; /** * * @param aepPath * @param compNames * @param targetBin */ importAEComps(aepPath: string, compNames: string[], targetBin?: ProjectItem): Promise; /** * * @param aepPath * @param targetBin */ importAllAEComps(aepPath: string, targetBin?: ProjectItem): Promise; /** * Import files in root/target bin of the project * * @param filePaths * @param suppressUI * @param targetBin * @param asNumberedStills */ importFiles( filePaths: string[], suppressUI?: boolean, targetBin?: ProjectItem, asNumberedStills?: boolean ): Promise; /** * * @param projectPath * @param sequenceIds */ importSequences(projectPath: string, sequenceIds?: Guid[]): Promise; /** * Open a sequence and return true if successful. * * @param sequence */ openSequence(sequence: Sequence): Promise; /** * 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 */ pauseGrowing(pause: boolean): Promise; /** * Save the project */ save(): Promise; /** * Saves a copy of the project at the provided path, mirroring the 'File > Save As' behavior in Premiere Pro: the newly saved copy becomes the active project, just as it would after using 'Save As' in the application. Separately, and perhaps unexpectedly, the `Project` object `saveAs()` was called on is itself updated in place to represent that new copy. It does not stay pinned to the original project file. This also affects chained calls, meaning calling `saveAs()` again on the same object saves a copy of that new file, not the original. To continue working with the original project--for example, to derive several independent copies from the same source--reopen it explicitly via `Project.open()` before each subsequent `saveAs()` call, rather than assuming the existing handle still refers to it. * * @param path */ saveAs(path: string): Promise; /** * Set the active sequence of the project * * @param sequence */ setActiveSequence(sequence: Sequence): Promise; /** * Execute undoable transaction by passing compound action * * @param callback * @param undoString */ executeTransaction( callback: (compoundAction: CompoundAction) => void, undoString?: string ): boolean; /** * 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. * * @param callback */ lockedAccess(callback: () => void): void; /** * The unique identifier of the project. * @readonly */ readonly guid: Guid; /** * The project name. * @readonly */ readonly name: string; /** * The absolute file path to the project file. * @readonly */ readonly path: string; }; export declare type ProjectClosedEventStatic = { /** * Event occurs when project was closed. * @readonly */ readonly EVENT_CLOSED: string; }; export declare type ProjectClosedEvent = { /** * The unique identifier of the project. * @readonly */ readonly id: string; /** * The project name. * @readonly */ readonly name: string; /** * The absolute file path to the project file. * @readonly */ readonly path: string; }; export declare type ProjectColorSettings = { /** * Get the graphics white luminance value */ getGraphicsWhiteLuminance(): Promise; /** * Get all the graphics white luminance as array of values */ getSupportedGraphicsWhiteLuminances(): Promise; }; export declare type ProjectConverterStatic = { /** * Export a sequence as an AAF (Advanced Authoring Format) file to the specified output path. * * @param sequence * @param filePath * @param aafExportOptions */ exportAAF( sequence: Sequence, filePath: string, aafExportOptions?: AAFExportOptions ): Promise; /** * Export a sequence as Final Cut Pro XML to the specified output file path. * * @param sequence * @param outputFilePath * @param suppressUI */ exportAsFinalCutProXML( sequence: Sequence, outputFilePath: string, suppressUI?: boolean ): Promise; /** * Export a sequence as OpenTimelineIO to the specified output file path. * * @param sequence * @param outputFilePath * @param suppressUI */ exportAsOpenTimelineIO( sequence: Sequence, outputFilePath: string, suppressUI?: boolean ): Promise; /** * AAF Export Audio Format AIFF * @readonly */ readonly AAF_EXPORT_AUDIO_FORMAT_AIFF: number; /** * AAF Export Audio Format WAV * @readonly */ readonly AAF_EXPORT_AUDIO_FORMAT_WAV: number; }; export declare type ProjectConverter = {}; export declare type ProjectEventStatic = { /** * Event occurs when the active project has changed * @readonly */ readonly EVENT_ACTIVATED: string; /** * Event occurs when the project dirty state changed. * @readonly */ readonly EVENT_DIRTY: string; /** * Event occurs when project was opened. * @readonly */ readonly EVENT_OPENED: string; }; export declare type ProjectEvent = { /** * The unique identifier of the project. * @readonly */ readonly id: string; /** * The project name. * @readonly */ readonly name: string; /** * The absolute file path to the project file. * @readonly */ readonly path: string; /** * The project object. * @readonly */ readonly project: Project; }; export declare type ProjectItemStatic = { /** * Cast FolderItem or ClipProjectItem in to ProjectItem * * @param item */ cast(item: FolderItem | ClipProjectItem): ProjectItem; /** * Project item type for bins/folders. * @readonly */ readonly TYPE_BIN: number; /** * Project item type for clips. * @readonly */ readonly TYPE_CLIP: number; /** * Project item type for compound clips. * @readonly */ readonly TYPE_COMPOUND: number; /** * Project item type for generic files. * @readonly */ readonly TYPE_FILE: number; /** * Project item type for the root container. * @readonly */ readonly TYPE_ROOT: number; /** * Project item type for styles. * @readonly */ readonly TYPE_STYLE: number; }; export declare type ProjectItem = { /** * Create an action for set color label to projectItem by index * * @param inColorLabelIndex */ createSetColorLabelAction(inColorLabelIndex: number): Action; /** * Returns action that renames projectItem * * @param inName */ createSetNameAction(inName: string): Action; /** * Get color label index of projectItem */ getColorLabelIndex(): Promise; /** * Get the parent Project of this projectItem. */ getProject(): Promise; /** * Get id of projectItem */ getId(): string; /** * Get parent FolderItem of projectItem */ getParentBin(): FolderItem; /** * The name of this project item. * @readonly */ readonly name: string; /** * Get the type of the Project Item. * @readonly */ readonly type: number; }; export declare type ProjectItemSelection = { /** * Get the project items that is represented by this selection. */ getItems(): Promise; }; export declare type ProjectSettingsStatic = { /** * Returns an action which sets IngestSettings * * @param project * @param ingestSettings */ createSetIngestSettingsAction(project: Project, ingestSettings: IngestSettings): Action; /** * Returns an action which sets ScratchDiskSetting * * @param project * @param scratchDiskSettings */ createSetScratchDiskSettingsAction( project: Project, scratchDiskSettings: ScratchDiskSettings ): Action; /** * Returns project ingest settings * * @param project */ getIngestSettings(project: Project): Promise; /** * Returns project ScratchDiskSettings * * @param project */ getScratchDiskSettings(project: Project): Promise; }; export declare type ProjectSettings = {}; export declare type ProjectUtilsStatic = { /** * Get project based on input view guid * * @param guid */ getProjectFromViewId(guid: Guid): Promise; /** * Get array of project view ids */ getProjectViewIds(): Promise; /** * Get array of selected project items in project view * * @param project */ getSelection(project: Project): Promise; /** * Get array of selected projectItem based on input view guid * * @param guid */ getSelectionFromViewId(guid: Guid): Promise; }; export declare type ProjectUtils = {}; export declare type PropertiesStatic = { /** * Return Property Owner Object * * @param propertyOwnerObject This can also be object instance of Project, Sequence etc.. */ getProperties(propertyOwnerObject: Project | Sequence): Promise; /** * Property is not persisted and will be cleared when the project closes. * @readonly */ readonly PROPERTY_NON_PERSISTENT: number; /** * Property is persistent in backend and shared across cloud project. * @readonly */ readonly PROPERTY_PERSISTENT: number; }; export declare type Properties = { /** * 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. * * @param name */ createClearValueAction(name: string): Action; /** * 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 * @param persistenceFlag Indicates whether the property should be persisted or not */ createSetValueAction( name: string, value: boolean | string | number, persistenceFlag: Constants.PropertyType ): Action; /** * Get named value in native string form * * @param name */ getValue(name: string): string; /** * Get named value as boolean * * @param name */ getValueAsBool(name: string): boolean; /** * Get named value as float number * * @param name */ getValueAsFloat(name: string): number; /** * Get named value as integer number * * @param name */ getValueAsInt(name: string): number; /** * Check if a named value exists under this name. * * @param name */ hasValue(name: string): boolean; }; export declare type RectFStatic = { /** * Constructs a new instance of the RectF class. * @constructor */ new (): RectF; (): RectF; }; export declare type RectF = { /** * Get/Set the height of a rect */ height: number; /** * Get/Set the width of a rect */ width: number; }; export declare type ScratchDiskSettingsStatic = { /** * Folder Type: AUDIOPREVIEW * @readonly */ readonly FOLDERTYPE_AUDIO_PREVIEW: string; /** * Folder Type: AUTOSAVE * @readonly */ readonly FOLDERTYPE_AUTO_SAVE: string; /** * Folder Type: CAPSULEMEDIA * @readonly */ readonly FOLDERTYPE_CAPSULE_MEDIA: string; /** * Folder Type: CAPTURED * @readonly */ readonly FOLDERTYPE_CAPTURE: string; /** * Folder Type: CCLLIBRARIES * @readonly */ readonly FOLDERTYPE_CCL_LIBRARIES: string; /** * Folder Type: VIDEOPREVIEW * @readonly */ readonly FOLDERTYPE_VIDEO_PREVIEW: string; /** * Folder: MYDOCUMNETS * @readonly */ readonly FOLDER_MY_DOCUMNETS: string; /** * Folder: SAMEASPROJECT * @readonly */ readonly FOLDER_SAME_AS_PROJECT: string; }; export declare type ScratchDiskSettings = { /** * Gets the scratchDisk location for specific disktype - may return symbolic paths for reserved types like 'MyDocuments' * * @param ScratchDiskType */ getScratchDiskPath(ScratchDiskType: Constants.ScratchDiskFolderType): string; /** * Sets project ScratchDisk Path * * @param ScratchDiskType * @param ScratchDiskValue */ setScratchDiskPath( ScratchDiskType: Constants.ScratchDiskFolderType, ScratchDiskValue: Constants.ScratchDiskFolder ): boolean; }; export declare type SequenceStatic = {}; export declare type Sequence = { /** * Clears TrackItem Selection */ clearSelection(): Promise; /** * Creates an action to clone the given sequence */ createCloneAction(): Action; /** * Create SetInPointAction for sequence * * @param tickTime */ createSetInPointAction(tickTime: TickTime): Action; /** * Create SetOutPointAction for sequence * * @param tickTime */ createSetOutPointAction(tickTime: TickTime): Action; /** * Returns an action that updates the settings for the sequence. * * @param sequenceSettings */ createSetSettingsAction(sequenceSettings: SequenceSettings): Action; /** * Create an action to set the zero point for the sequence. * * @param tickTime */ createSetZeroPointAction(tickTime: TickTime): Action; /** * Returns a new sequence, which is a sub-sequence of the existing sequence * * @param ignoreTrackTargeting */ createSubsequence(ignoreTrackTargeting?: boolean): Promise; /** * Get audio track from track index * * @param trackIndex */ getAudioTrack(trackIndex: number): Promise; /** * Get audio track count from this sequence */ getAudioTrackCount(): Promise; /** * Get caption track from track index * * @param trackIndex */ getCaptionTrack(trackIndex: number): Promise; /** * Get caption track count from this sequence */ getCaptionTrackCount(): Promise; /** * Time representing the end of the sequence */ getEndTime(): Promise; /** * Gets the size of the frame */ getFrameSize(): Promise; /** * Get time representing the in point of the sequence. */ getInPoint(): Promise; /** * Get time representing the out point of the sequence. */ getOutPoint(): Promise; /** * Get the player's current position */ getPlayerPosition(): Promise; /** * Get the associated projectItem of the sequence. */ getProjectItem(): Promise; /** * Returns the current selection group of the sequence. */ getSelection(): Promise; /** * Get audio time display format of this sequence */ getSequenceAudioTimeDisplayFormat(): Promise; /** * Get video time display format of this sequence */ getSequenceVideoTimeDisplayFormat(): Promise; /** * Get sequence settings object */ getSettings(): Promise; /** * Gets the time base of sequence */ getTimebase(): Promise; /** * Get video track from track index * * @param trackIndex */ getVideoTrack(trackIndex: number): Promise; /** * Get video track count from this sequence */ getVideoTrackCount(): Promise; /** * Time representing the zero point of the sequence. */ getZeroPoint(): Promise; /** * Returns whether or not the sequence is done analyzing for video effects */ isDoneAnalyzingForVideoEffects(): Promise; /** * Set the player's current position * * @param positionTime */ setPlayerPosition(positionTime?: TickTime): Promise; /** * Updates sequence selection using the given track item selection. * * @param trackItemSelection */ setSelection(trackItemSelection: TrackItemSelection): boolean; /** * The unique identifier of the sequence. * @readonly */ readonly guid: Guid; /** * The sequence name. * @readonly */ readonly name: string; }; export declare type SequenceEditorStatic = { /** * Get Sequence Editor reference for editing the sequence timeline * * @param sequenceObject */ getEditor(sequenceObject: Sequence): SequenceEditor; /** * Get local directory path to adobe mogrt files */ getInstalledMogrtPath(): Promise; }; export declare type SequenceEditor = { /** * Create remove action for sequence * * @param trackItemSelection * @param ripple * @param mediaType * @param shiftOverLapping */ createRemoveItemsAction( trackItemSelection: TrackItemSelection, ripple: boolean, mediaType: Constants.MediaType, shiftOverLapping?: boolean ): Action; /** * 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. * * @param projectItem * @param time * @param videoTrackIndex * @param audioTrackIndex * @param limitShift */ createInsertProjectItemAction( projectItem: ProjectItem, time: TickTime, videoTrackIndex: number, audioTrackIndex: number, limitShift: boolean ): Action; /** * Create overwrite Sequence with ProjectItem Action * * @param projectItem * @param time * @param videoTrackIndex * @param audioTrackIndex */ createOverwriteItemAction( projectItem: ProjectItem, time: TickTime, videoTrackIndex: number, audioTrackIndex: number ): Action; /** * 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. * * @param trackItem * @param timeOffset * @param videoTrackVerticalOffset * @param audioTrackVerticalOffset * @param alignToVideo * @param isInsert */ createCloneTrackItemAction( trackItem: VideoClipTrackItem | AudioClipTrackItem, timeOffset: TickTime, videoTrackVerticalOffset: number, audioTrackVerticalOffset: number, alignToVideo: boolean, isInsert: boolean ): Action; /** * Insert input MGT into sequence with time and index defined * * @param inMGTPath * @param inTime * @param inVideoTrackIndex * @param inAudioTrackIndex */ insertMogrtFromPath( inMGTPath: string, inTime: TickTime, inVideoTrackIndex: number, inAudioTrackIndex: number ): Array; /** * Insert input MGT into sequence with time and index defined * * @param inLibraryName * @param inElementName * @param inTime * @param inVideoTrackIndex * @param inAudioTrackIndex */ insertMogrtFromLibrary( inLibraryName: string, inElementName: string, inTime: TickTime, inVideoTrackIndex: number, inAudioTrackIndex: number ): Array; }; export declare type SequenceSettingsStatic = { /** * Audio Channel Type 5.1 * @readonly */ readonly AUDIO_CHANNEL_TYPE_51: number; /** * Audio Channel Type Mono * @readonly */ readonly AUDIO_CHANNEL_TYPE_MONO: number; /** * Audio Channel Type Multi * @readonly */ readonly AUDIO_CHANNEL_TYPE_MULTI: number; /** * Audio Channel Type Stereo * @readonly */ readonly AUDIO_CHANNEL_TYPE_STEREO: number; /** * Audio Display format miliseconds * @readonly */ readonly AUDIO_DISPLAY_FORMAT_MILISECONDS: number; /** * Audio Display format: Audio Sample Timecode * @readonly */ readonly AUDIO_DISPLAY_FORMAT_SAMPLE_RATE: number; /** * Anamorphic 2:1 (2.0) * @readonly */ readonly PAR_Anamorphic: string; /** * DVCPRO HD (1.5) * @readonly */ readonly PAR_DVCProHD: string; /** * DV NTSC (0.9091) * @readonly */ readonly PAR_DVNTSC: string; /** * DV NTSC Widescreen 16:9 (1.2121) * @readonly */ readonly PAR_DVNTSCWide: string; /** * DV PAL (1.0940) * @readonly */ readonly PAR_DVPAL: string; /** * DV PAL Widescreen 16:9 (1.4587) * @readonly */ readonly PAR_DVPALWide: string; /** * HD Anamorphic 1080 (1.333) * @readonly */ readonly PAR_HDAnamorphic1080: string; /** * Square Pixels (1.0) * @readonly */ readonly PAR_SQUARE: string; /** * Feet+Frame 16mm * @readonly */ readonly VIDEO_DISPLAY_FORMAT_16mm: number; /** * 23.976 fps TimeCode * @readonly */ readonly VIDEO_DISPLAY_FORMAT_23976: number; /** * 25 fps TimeCode * @readonly */ readonly VIDEO_DISPLAY_FORMAT_25: number; /** * 29.97 fps TimeCode * @readonly */ readonly VIDEO_DISPLAY_FORMAT_2997: number; /** * 29.97 fps Non-Drop-Frame TimeCode * @readonly */ readonly VIDEO_DISPLAY_FORMAT_2997_NON_DROP: number; /** * Feet+Frame 35mm * @readonly */ readonly VIDEO_DISPLAY_FORMAT_35mm: number; /** * Frames * @readonly */ readonly VIDEO_DISPLAY_FORMAT_FRAMES: number; /** * Video field type lower first * @readonly */ readonly VIDEO_FIELDTYPE_LOWER_FIRST: number; /** * Video field type progressive * @readonly */ readonly VIDEO_FIELDTYPE_PROGRESSIVE: number; /** * Video field type upper first * @readonly */ readonly VIDEO_FIELDTYPE_UPPER_FIRST: number; }; export declare type SequenceSettings = { /** * Get number of channels in the sequence */ getAudioChannelCount(): Promise; /** * Get Audio channel type of sequence. Could be 0 (Mono), 1 (Stereo), 2 (5.1), or 3 (multichannel) */ getAudioChannelType(): Promise; /** * Get Audio display format */ getAudioDisplayFormat(): Promise; /** * Get audio sample rate */ getAudioSampleRate(): Promise; /** * Get if composite in linear color is checked */ getCompositeInLinearColor(): Promise; /** * Get editing mode of sequence */ getEditingMode(): Promise; /** * Find if maximum render quality is set */ getMaxRenderQuality(): Promise; /** * Find if maximum bit depth is set */ getMaximumBitDepth(): Promise; /** * Get preview codec of sequence */ getPreviewCodec(): Promise; /** * Get preview file format of sequence */ getPreviewFileFormat(): Promise; /** * Get preview video frame rect in the sequence */ getPreviewFrameRect(): Promise; /** * Get Video display format */ getVideoDisplayFormat(): Promise; /** * Get video field type in the sequence */ getVideoFieldType(): Promise; /** * Get video frame rate in the sequence */ getVideoFrameRate(): FrameRate; /** * Get video frame rect in the sequence */ getVideoFrameRect(): Promise; /** * Get Video display format */ getVideoPixelAspectRatio(): Promise; /** * Set audio display format of sequence. * * @param audioDisplay */ setAudioDisplayFormat(audioDisplay: TimeDisplay): Promise; /** * Set audio sample rate * * @param inRate */ setAudioSampleRate(inRate: FrameRate): Promise; /** * Set if composite in linear color is checked * * @param useCompositeInLinearColor */ setCompositeInLinearColor(useCompositeInLinearColor: boolean): Promise; /** * Set editing mode of sequence * * @param inEditingModeName */ setEditingMode(inEditingModeName: string): Promise; /** * Set maximum render quality to true/false * * @param useMaxRenderQuality */ setMaxRenderQuality(useMaxRenderQuality: boolean): Promise; /** * Set maximum bit depth to true/false * * @param useMaxBitDepth */ setMaximumBitDepth(useMaxBitDepth: boolean): Promise; /** * Set preview codec of sequence * * @param inPreviewCodec */ setPreviewCodec(inPreviewCodec: string): Promise; /** * Set preview file format of sequence * * @param inPreviewCodec */ setPreviewFileFormat(inPreviewCodec: string): Promise; /** * Set preview video frame rect in sequence * * @param inPreviewVideoRect */ setPreviewFrameRect(inPreviewVideoRect: RectF): Promise; /** * Set video display format of sequence * * @param audioDisplay */ setVideoDisplayFormat(audioDisplay: TimeDisplay): Promise; /** * Set video field type in sequence * * @param videoFiledType */ setVideoFieldType(videoFiledType: number): Promise; /** * Set video frame rate in the sequence * * @param inVideoFrameRate */ setVideoFrameRate(inVideoFrameRate: FrameRate): boolean; /** * Set video frame rect in sequence * * @param inVideoFrameRect */ setVideoFrameRect(inVideoFrameRect: RectF): Promise; /** * Set video display format of sequence * * @param inPixelAspectRatio */ setVideoPixelAspectRatio(inPixelAspectRatio: string): Promise; }; export declare type SequenceUtilsStatic = { /** * Performs cut detection on the sequence selection * * @param clipOperation * @param trackItemSelection */ performSceneEditDetectionOnSelection( clipOperation: string, trackItemSelection: TrackItemSelection ): Promise; /** * ApplyCuts * @readonly */ readonly SEQUENCE_OPERATION_APPLYCUT: string; /** * CreateMarkers * @readonly */ readonly SEQUENCE_OPERATION_CREATEMARKER: string; /** * CreateSubclips * @readonly */ readonly SEQUENCE_OPERATION_CREATESUBCLIP: string; }; export declare type SequenceUtils = {}; export declare type SnapEventStatic = { /** * Event occurs when the playhead snaps into track-item edges. * @readonly */ readonly EVENT_SNAP_PLAYHEAD_TO_TRACKITEM_EDGE: string; /** * Event occurs when the razor tool hovers over the all types of markers and snaps into position for a cut. * @readonly */ readonly EVENT_SNAP_RAZOR_TO_MARKER: string; /** * Event occurs when the razor tool hovers over the playhead and snaps into position for a cut. * @readonly */ readonly EVENT_SNAP_RAZOR_TO_PLAYHEAD: string; /** * Event occurs object is snapped to guildelines when holding the Cmd/Ctrl key. * @readonly */ readonly EVENT_SNAP_TO_GUIDES: string; /** * Event occurs a user scrub on timeline over keyframes when shift key is applied. * @readonly */ readonly EVENT_SNAP_TO_KEYFRAME: string; /** * Event occurs a user scrub on timeline and snaps to various track item alignments. * @readonly */ readonly EVENT_SNAP_TO_TRACKITEM: string; }; export declare type SnapEvent = {}; export declare type SourceMonitorStatic = { /** * Close all clips on Source Monitor */ closeAllClips(): Promise; /** * Close clip on Source Monitor */ closeClip(): Promise; /** * Get position of source monitor in time */ getPosition(): Promise; /** * Get projectItem at source monitor */ getProjectItem(): Promise; /** * Open the item at the specified path and send to the Source Monitor for preview * * @param filePath */ openFilePath(filePath: string): Promise; /** * Open input projectItem on Source Monitor * * @param projectItem */ openProjectItem(projectItem: ProjectItem): Promise; /** * Play clip at source monitor with input speed * * @param speed */ play(speed?: number): Promise; /** * Set position of source monitor to the given TickTime * * @param position */ setPosition(position: TickTime): Promise; }; export declare type SourceMonitor = {}; export declare type TextSegmentsStatic = { /** * Import text segments in JSON format for handling via callback. * * @param json * @param undefined */ importFromJSON(json: string, callback1: (importedTranscription: TextSegments) => void): boolean; }; export declare type TextSegments = {}; export declare type TickTimeStatic = { /** * Constructs a TickTime object * @constructor */ new (): TickTime; (): TickTime; /** * Constructs a TickTime object with a frame and a frame rate. * * @param frameCount * @param frameRate */ createWithFrameAndFrameRate(frameCount: number, frameRate: FrameRate): TickTime; /** * Constructs a TickTime object with seconds. * * @param seconds */ createWithSeconds(seconds: number): TickTime; /** * Constructs a TickTime object with ticks as a string. * * @param ticks */ createWithTicks(ticks: string): TickTime; /** * Invalid Tick Time Constant * @readonly */ readonly TIME_INVALID: TickTime; /** * Max Tick Time Constant * @readonly */ readonly TIME_MAX: TickTime; /** * Min Tick Time Constant * @readonly */ readonly TIME_MIN: TickTime; /** * One Hour Tick Time Constant * @readonly */ readonly TIME_ONE_HOUR: TickTime; /** * One Second Tick Time Constant * @readonly */ readonly TIME_ONE_MINUTE: TickTime; /** * One Second Tick Time Constant * @readonly */ readonly TIME_ONE_SECOND: TickTime; /** * Zero Tick Time Constant * @readonly */ readonly TIME_ZERO: TickTime; }; export declare type TickTime = { /** * Add another TickTime to this one and return it. This TickTime is not modified. * * @param tickTime */ add(tickTime: TickTime): TickTime; /** * 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. * * @param frameRate */ alignToFrame(frameRate: FrameRate): TickTime; /** * 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. * * @param frameRate */ alignToNearestFrame(frameRate: FrameRate): TickTime; /** * 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. * * @param divisor */ divide(divisor: number): TickTime; /** * Returns true if the given TickTime is equal to the TickTime object * * @param tickTime */ equals(tickTime: TickTime): boolean; /** * Multiply this TickTime with a factor and return it. This TickTime is not modified. * * @param factor */ multiply(factor: number): TickTime; /** * Subtract another TickTime from this one and return it. This TickTime is not modified. * * @param tickTime */ subtract(tickTime: TickTime): TickTime; /** * Get the TickTime in seconds * @readonly */ readonly seconds: number; /** * Get the TickTime in ticks as a string * @readonly */ readonly ticks: string; /** * Get the TickTime in ticks as a number * @readonly */ readonly ticksNumber: number; }; export declare type TimeDisplay = { /** * Read/Write property to get/set the time display type numeric code */ type: number; }; export declare type TrackItemSelectionStatic = { /** * Create empty selection * * @param undefined */ createEmptySelection(callback0: (selection: TrackItemSelection) => void): boolean; }; export declare type TrackItemSelection = { /** * Add a track item to this selection * * @param trackItem trackItem to be added to selection * @param skipDuplicateCheck */ addItem( trackItem: VideoClipTrackItem | AudioClipTrackItem, skipDuplicateCheck?: boolean ): boolean; /** * Remove a track item from this selection * * @param trackItem trackItem to be removed from selection */ removeItem(trackItem: VideoClipTrackItem | AudioClipTrackItem): boolean; /** * return list of trackItems inside of trackItemSelection */ getTrackItems(): Promise>; }; export declare type TransitionFactoryStatic = { /** * Creates a new video filter component based on the input matchName * * @param matchName */ createVideoTransition(matchName: string): VideoTransition; /** * Return a promise which will be fullfilled with an array of video transition matchnames */ getVideoTransitionMatchNames(): Promise; }; export declare type TransitionFactory = {}; export declare type UniqueSerializeableStatic = { /** * Cast serializable object (ex. ProjectItem) into UniqueSerializeable * * @param item */ cast(item: ProjectItem | ClipProjectItem | FolderItem | Sequence): UniqueSerializeable; }; export declare type UniqueSerializeable = { /** * Get the unique ID of the serializeable object */ getUniqueID(): Guid; }; export declare type UtilsStatic = { /** * Check if AE is installed. */ isAEInstalled(): Promise; }; export declare type Utils = {}; export declare type VideoClipTrackItemStatic = { /** * Clip Track Item Type * @readonly */ readonly TRACKITEMTYPE_CLIP: number; /** * Empty Track Item Type * @readonly */ readonly TRACKITEMTYPE_EMPTY: number; /** * Feedback Track Item Type * @readonly */ readonly TRACKITEMTYPE_FEEDBACK: number; /** * Previe Track Item Type * @readonly */ readonly TRACKITEMTYPE_PREVIEW: number; /** * Transition Track Item Type * @readonly */ readonly TRACKITEMTYPE_TRANSITION: number; }; export declare type VideoClipTrackItem = { /** * Create add transition action for sequence * * @param videoTransition * @param addTransitionOptionsProperties */ createAddVideoTransitionAction( videoTransition: VideoTransition, addTransitionOptionsProperties?: AddTransitionOptions ): Action; /** * Returns true if trackItem has transition * * @param transitionPosition Start or end position of transition */ createRemoveVideoTransitionAction(transitionPosition?: Constants.TransitionPosition): Action; /** * Returns an action that moves the inPoint of the track item to a new time, by shifting it by a number of seconds. * * @param tickTime */ createMoveAction(tickTime: TickTime): Action; /** * Returns an action that enables/disables the trackItem * * @param disabled */ createSetDisabledAction(disabled: boolean): Action; /** * Create set end time action for sequence * * @param tickTime */ createSetEndAction(tickTime: TickTime): Action; /** * Create SetInPointAction for setting the track item in point relative to the start time of the project item referenced by this track item * * @param tickTime Sets the In-Point in TickTime */ createSetInPointAction(tickTime: TickTime): Action; /** * Returns an action that renames the trackItem * * @param inName */ createSetNameAction(inName: string): Action; /** * Create SetOutPointAction for setting the track item out point relative to the start time of the project item referenced by this track item * * @param tickTime Sets the Out-Point in TickTime */ createSetOutPointAction(tickTime: TickTime): Action; /** * Create set start time action for sequence * * @param tickTime */ createSetStartAction(tickTime: TickTime): Action; /** * Returns timecode representing the duration of this track item relative to the sequence start. */ getDuration(): Promise; /** * Returns a TickTime object representing the ending sequence time of this track item relative to the sequence start time. */ getEndTime(): Promise; /** * Returns a TickTime object representing the track item in point relative to the start time of the project item referenced by this track item. */ getInPoint(): Promise; /** * Returns if trackItem is selected or not */ getIsSelected(): Promise; /** * Returns the value of internal matchname for this trackItem */ getMatchName(): Promise; /** * Returns UUID representing the underlying media type of this track item */ getMediaType(): Promise; /** * Returns the display name for trackItem */ getName(): Promise; /** * Returns a TickTime object representing the track item out point relative to the start time of the project item referenced by this track item. */ getOutPoint(): Promise; /** * Returns the project item for this track item. */ getProjectItem(): Promise; /** * Returns the value of speed of the trackItem */ getSpeed(): Promise; /** * Returns a TickTime object representing the starting sequence time of this track item relative to the sequence start time. */ getStartTime(): Promise; /** * Index representing the track index of the track this track item belongs to */ getTrackIndex(): Promise; /** * Index representing the type of this track item. */ getType(): Promise; /** * Returns true if the trackitem is an adjustment layer */ isAdjustmentLayer(): Promise; /** * Returns true if trackitem is muted/disabled */ isDisabled(): Promise; /** * Returns true if the trackitem is reversed */ isSpeedReversed(): Promise; /** * Returns VideoComponentChain */ getComponentChain(): Promise; }; export declare type VideoComponentChainStatic = {}; export declare type VideoComponentChain = { /** * Creates and returns an append component action * * @param component Video filter component */ createAppendComponentAction(component: Component | VideoFilterComponent): Action; /** * Creates and returns an insert component action * * @param component Video filter component * @param componentInsertionIndex Index which the component shall be inserted */ createInsertComponentAction( component: Component | VideoFilterComponent, componentInsertionIndex: number ): Action; /** * Creates and returns an remove component action * * @param component Video filter component */ createRemoveComponentAction(component: Component | VideoFilterComponent): Action; /** * Returns the component at the given index * * @param componentIndex * @returns Returns the component at the given index */ getComponentAtIndex(componentIndex: number): Component; /** * Gets the number of components in the component chain */ getComponentCount(): number; }; export declare type VideoFilterComponentStatic = {}; export declare type VideoFilterComponent = {}; export declare type VideoFilterFactoryStatic = { /** * Creates a new video filter component based on the input matchName * * @param matchName The match name of the component to create, example 'PR.ADBE Solarize', 'AE.ADBE Mosaic' etc.. */ createComponent(matchName: string): Promise; /** * Returns an array of video filter display names */ getDisplayNames(): Promise; /** * Returns an array of video filter matchNames */ getMatchNames(): Promise; }; export declare type VideoFilterFactory = {}; export declare type VideoTrackStatic = { /** * Event Object for Track changed * @readonly */ readonly EVENT_TRACK_CHANGED: string; /** * Event Object for Track Info Changed * @readonly */ readonly EVENT_TRACK_INFO_CHANGED: string; /** * Event Object for Track Lock Changed * @readonly */ readonly EVENT_TRACK_LOCK_CHANGED: string; }; export declare type VideoTrack = { /** * Action to change the name of the track * * @param name */ createSetNameAction(name: string): Action; /** * Index representing the track index of this track within the track group. */ getIndex(): Promise; /** * UUID representing the underlying media type of this track */ getMediaType(): Promise; /** * Get mute state of the track */ isMuted(): Promise; /** * sets the mute state of the track to muted/unmuted * * @param mute */ setMute(mute: boolean): Promise; /** * Returns array of VideoClipTrackItem from the track item type * * @param trackItemType This values can be Empty (0), Clip (1), Transition (2), Preview (3) or Feedback (4) * @param includeEmptyTrackItems */ getTrackItems( trackItemType: Constants.TrackItemType, includeEmptyTrackItems: boolean ): VideoClipTrackItem[]; /** * The ID of the track within the TrackGroup * @readonly */ readonly id: number; /** * Get the name of the track * @readonly */ readonly name: string; }; export declare type VideoTransitionStatic = { /** * TransitionPosition: END * @readonly */ readonly TRANSITIONPOSITION_END: number; /** * TransitionPosition: START * @readonly */ readonly TRANSITIONPOSITION_START: number; }; 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 and out points of the sequence. * * @param sequence * @param inTickTime * @param outTickTime */ setWorkAreaInOutPoints(sequence: Sequence, inTickTime: TickTime, outTickTime: TickTime): boolean; /** * 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; }; export declare type WorkAreaUtils = {}; export declare type EventManagerStatic = { /** * add event listener to target object * * @param target * @param eventName * @param eventHandler * @param inCapturePhase */ addEventListener( target: Project | Sequence | VideoTrack | AudioTrack | EncoderManager, eventName: | string | Constants.SnapEvent | Constants.ProjectEvent | Constants.SequenceEvent | Constants.OperationCompleteEvent, eventHandler: (event?: object) => void, inCapturePhase?: boolean ): void; /** * remove event listener from target object * * @param target * @param eventName * @param eventHandler */ removeEventListener( target: Project | Sequence | VideoTrack | AudioTrack | EncoderManager, eventName: | string | Constants.SnapEvent | Constants.ProjectEvent | Constants.SequenceEvent | Constants.OperationCompleteEvent, eventHandler: (event?: object) => void ): void; /** * add global event listener * * @param eventName * @param eventHandler * @param inCapturePhase */ addGlobalEventListener( eventName: | string | Constants.SnapEvent | Constants.ProjectEvent | Constants.SequenceEvent | Constants.OperationCompleteEvent, eventHandler: (event?: object) => void, inCapturePhase?: boolean ): void; /** * remove global event listener * * @param eventName * @param eventHandler */ removeGlobalEventListener( eventName: | string | Constants.SnapEvent | Constants.ProjectEvent | Constants.SequenceEvent | Constants.OperationCompleteEvent, eventHandler: (event?: object) => void ): void; }; export declare type EventManager = {}; export declare type TranscriptStatic = { /** * Returns TextSegments object initialized from jsonString * * @param jsonString */ importFromJSON(jsonString: string): TextSegments; /** * Create action that import external transcripts to ClipProjectItem * * @param textSegments * @param clipProjectItem */ createImportTextSegmentsAction( textSegments: TextSegments, clipProjectItem: ClipProjectItem ): Action; /** * Returns the list of language services available for transcription */ 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 * * @param clipProjectItem */ hasTranscript(clipProjectItem: ClipProjectItem): boolean; /** * Transcribes the clip audio associated with the given ClipProjectItem * * @param clipProjectItem * @param options */ transcribeClipProjectItem( clipProjectItem: ClipProjectItem, options?: { languageCode?: string } ): Promise; /** * Export transcripts inside of clipProjectItem as JSON string if transcript exist * * @param clipProjectItem */ exportToJSON(clipProjectItem: ClipProjectItem): Promise; }; export declare type Transcript = {}; export namespace Constants { /** * @since 26.3 */ export enum AAFExportAudioFormat { AIFF, WAV, } export enum AudioChannelType { MONO, STEREO, SURROUND_51, MULTI, } export enum AudioDisplayFormatType { SAMPLE_RATE, MILLISECONDS, } export enum AudioTrackEvent { TRACK_CHANGED, INFO_CHANGED, LOCK_CHANGED, } /** * @since 26.5 */ export enum C2PAManifestLocation { CLOUD, EMBEDDED, NONE, SIDE_CAR, } export enum ContentType { ANY, SEQUENCE, MEDIA, } export enum EncoderEvent { RENDER_COMPLETE, RENDER_ERROR, RENDER_CANCEL, RENDER_QUEUE, RENDER_PROGRESS, } export enum ExportType { QUEUE_TO_AME, QUEUE_TO_APP, IMMEDIATELY, } export enum InterpolationMode { BEZIER, HOLD, LINEAR, TIME, TIME_TRANSITION_END, 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, CYAN, } export enum MediaType { ANY, DATA, VIDEO, AUDIO, } export enum MetadataType { INTEGER, REAL, TEXT, BOOLEAN, } export enum OperationCompleteEvent { CLIP_EXTEND_REACHED, EFFECT_DROP_COMPLETE, EFFECT_DRAG_OVER, EXPORT_MEDIA_COMPLETE, GENERATIVE_EXTEND_COMPLETE, IMPORT_MEDIA_COMPLETE, } export enum OperationCompleteState { SUCCESS, CANCELLED, FAILED, } export enum PixelAspectRatio { SQUARE, DVNTSC, DVNTSCWide, DVPAL, DVPALWide, Anamorphic, HDAnamorphic1080, DVCProHD, } export enum PreferenceKey { AUTO_PEAK_GENERATION, IMPORT_WORKSPACE, SHOW_QUICKSTART_DIALOG, } export enum ProjectEvent { OPENED, CLOSED, DIRTY, ACTIVATED, PROJECT_ITEM_SELECTION_CHANGED, } export enum ProjectItemColorLabel { VIOLET, IRIS, LAVENDER, CERULEAN, FOREST, ROSE, MANGO, PURPLE, BLUE, TEAL, MAGENTA, TAN, GREEN, BROWN, YELLOW, } export enum PropertyType { PERSISTENT, NON_PERSISTENT, } export enum ScratchDiskFolder { SAME_AS_PROJECT, MY_DOCUMENTS, } export enum ScratchDiskFolderType { CAPTURE, AUDIO_PREVIEW, VIDEO_PREVIEW, AUTO_SAVE, CCL_LIBRARIES, CAPSULE_MEDIA, } export enum SequenceEvent { ACTIVATED, CLOSED, SELECTION_CHANGED, } export enum SequenceOperation { APPLYCUT, CREATEMARKER, CREATESUBCLIP, } export enum SnapEvent { KEYFRAME, RAZOR_PLAYHEAD, RAZOR_MARKER, TRACKITEM, GUIDES, PLAYHEAD_TRACKITEM, } export enum TrackItemType { EMPTY, CLIP, TRANSITION, PREVIEW, FEEDBACK, } export enum TransitionPosition { START, END, } export enum VideoDisplayFormatType { FPS_23_976, FPS_25, FPS_29_97, FPS_29_97_NON_DROP, FEET_FRAME_16mm, FEET_FRAME_35mm, FRAMES, } export enum VideoFieldType { PROGRESSIVE, UPPER_FIRST, LOWER_FIRST, } export enum VideoTrackEvent { TRACK_CHANGED, INFO_CHANGED, LOCK_CHANGED, } } export default premierepro;