Project
Since: 25.6
Properties
Static Methods
createProject
Create a new project
Since: 25.6
Returns: Promise<Project>
Parameters
getActiveProject
Currently active project.
Since: 25.6
Returns: Promise<Project>
getProject
Get project referenced by given UID
Since: 25.6
Returns: Project
Parameters
isProject
Returns true if the file at the given path is openable as a Premiere project
Since: 26.2
Returns: boolean
Parameters
open
Open a project
Since: 25.6
Returns: Promise<Project>
Parameters
Instance Methods
close
Close a project
Since: 25.6
Returns: Promise<boolean>
Parameters
closeSequence
Close a sequence and return true if successful.
Since: 26.2
Returns: Promise<boolean>
Parameters
createSequence
Create a new sequence with the default preset path - Parameter presetPath is deprecated, instead use createSequenceWithPresetPath()
Since: 25.6
Returns: Promise<Sequence>
Parameters
createSequenceFromMedia
Create a new sequence with a given name and media
Since: 25.6
Returns: Promise<Sequence>
Parameters
createSequenceWithPresetPath
Create a new sequence with a preset path
Since: 26.3
Returns: Promise<Sequence>
Parameters
deleteSequence
Delete a given sequence from the project
Since: 25.6
Returns: Promise<boolean>
Parameters
executeTransaction
Execute undoable transaction by passing compound action
Since: 25.6
Returns: boolean
Parameters
getActiveSequence
Get the active sequence of the project
Since: 25.6
Returns: Promise<Sequence>
getColorSettings
Get project color settings object
Since: 25.6
Returns: Promise<ProjectColorSettings>
getInsertionBin
Get current insertion bin
Since: 25.6
Returns: Promise<ProjectItem>
getRootItem
The root item of the project which contains all items of the project on the lowest level.
Since: 25.6
Returns: Promise<FolderItem>
getSequence
Get sequence by id from the project
Since: 25.6
Returns: Sequence
Parameters
getSequences
Get an array of all sequences in this project.
Since: 25.6
Returns: Promise<Sequence[]>
importAEComps
Since: 25.6
Returns: Promise<boolean>
Parameters
importAllAEComps
Since: 25.6
Returns: Promise<boolean>
Parameters
importFiles
Import files in root/target bin of the project
Since: 25.6
Returns: Promise<boolean>
Parameters
importSequences
Since: 25.6
Returns: Promise<boolean>
Parameters
lockedAccess
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.
Since: 25.6
Returns: void
Parameters
openSequence
Open a sequence and return true if successful.
Since: 25.6
Returns: Promise<boolean>
Parameters
pauseGrowing
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.
Since: 25.6
Returns: Promise<boolean>
Parameters
save
Save the project
Since: 25.6
Returns: Promise<boolean>
saveAs
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.
Since: 25.6
Returns: Promise<boolean>
Parameters
setActiveSequence
Set the active sequence of the project
Since: 25.6
Returns: Promise<boolean>