Project

Properties

NameTypeAccessMin VersionDescription
guid
Guid
R
25.0
The unique identifier of the project.
name
string
R
25.0
The project name.
path
string
R
25.0
The absolute file path to the project file.

Static Methods

createProject

25.0

Project

Create a new project

Parameters

NameTypeDescription
path
string
-

getActiveProject

25.0

Project

Currently active project.


getProject

25.0

Project

Get project referenced by given UID

Parameters

NameTypeDescription
projectGuid
-

open

25.0

Project

Open a project

Parameters

NameTypeDescription
path
string
-
openProjectOptions
-

Instance Methods

close

25.0

boolean

Close a project

Parameters

NameTypeDescription
closeProjectOptions
-

createSequence

25.0

Sequence

Create a new sequence with the default preset path - Parameter presetPath is deprecated, instead use createSequenceWithPresetPath()

Parameters

NameTypeDescription
name
string
-
presetPath
string
-

createSequenceFromMedia

25.0

Sequence

Create a new sequence with a given name and medias

Parameters

NameTypeDescription
name
string
-
clipProjectItems
-
targetBin
-

deleteSequence

25.0

boolean

Delete a given sequence from the project

Parameters

NameTypeDescription
sequence
-

executeTransaction

25.0

boolean

Execute undoable transaction by passing compound action

Parameters

NameTypeDescription
callback
(compoundAction: CompoundAction) => void
-
undoString?
string
-

getActiveSequence

25.0

Sequence

Get the active sequence of the project


getColorSettings

25.0

ProjectColorSettings

Get project color settings object


getInsertionBin

25.0

ProjectItem

Get current insertion bin


getRootItem

25.0

FolderItem

The root item of the project which contains all items of the project on the lowest level.


getSequence

25.0

Sequence

Get sequence by id from the project

Parameters

NameTypeDescription
guid
-

getSequences

25.0

Sequence[]

Get an array of all sequences in this project.


importAEComps

25.0

boolean

Parameters

NameTypeDescription
aepPath
string
-
compNames
-
TargetBin
-

importAllAEComps

25.0

boolean

Parameters

NameTypeDescription
aepPath
string
-
TargetBin
-

importFiles

25.0

boolean

Import files in root/target bin of the project

Parameters

NameTypeDescription
filePaths
-
suppressUI
boolean
-
targetBin
-
asNumberedStills
boolean
-

importSequences

25.0

boolean

Parameters

NameTypeDescription
projectPath
string
-
sequenceIds
-

lockedAccess

25.0

void

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.

Parameters

NameTypeDescription
callback
() => void
-

openSequence

25.0

boolean

Open a sequence and return true if successful.

Parameters

NameTypeDescription
sequence
-

pauseGrowing

25.0

boolean

Pause growing of files instead swap the files

Parameters

NameTypeDescription
pause
boolean
-

save

25.0

boolean

Save the project


saveAs

25.0

boolean

Save the project at the provided path

Parameters

NameTypeDescription
path
string
-

setActiveSequence

25.0

boolean

Set the active sequence of the project

Parameters

NameTypeDescription
sequence
-

  • Privacy
  • Terms of Use
  • Do not sell or share my personal information
  • AdChoices
Copyright © 2025 Adobe. All rights reserved.