Project

Properties

Name

Type

Access

Min Version

Description

guid

Guid

25.0

The unique identifier of the project.

name

string

25.0

The project name.

path

string

25.0

The absolute file path to the project file.

Static Methods

createProject

25.0

Project

Create a new project

Parameters

Name

Type

Description

path

string

getActiveProject

25.0

Project

Currently active project.

getProject

25.0

Project

Get project referenced by given UID

Parameters

Name

Type

Description

projectGuid

Guid

isProject

25.0

boolean

Returns true if the file at the given path is openable as a Premiere project

Parameters

Name

Type

Description

projectPath

string

open

25.0

Project

Open a project

Parameters

Name

Type

Description

path

string

openProjectOptions

OpenProjectOptions

Instance Methods

close

25.0

boolean

Close a project

Parameters

Name

Type

Description

closeProjectOptions

CloseProjectOptions

closeSequence

25.0

boolean

Close a sequence and return true if successful.

Parameters

Name

Type

Description

sequence

Sequence

createSequence

25.0

Sequence

Create a new sequence using the default preset path.

Note: The presetPath parameter is deprecated. Use createSequenceWithPresetPath() instead.

Parameters

Name

Type

Description

name

string

presetPath

string

createSequenceFromMedia

25.0

Sequence

Create a new sequence with a given name and medias

Parameters

Name

Type

Description

name

string

clipProjectItems

ClipProjectItem[]

targetBin

ProjectItem

deleteSequence

25.0

boolean

Delete a given sequence from the project

Parameters

Name

Type

Description

sequence

Sequence

executeTransaction

25.0

boolean

Execute undoable transaction by passing compound action

Parameters

Name

Type

Description

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

Name

Type

Description

guid

Guid

getSequences

25.0

Sequence[]

Get an array of all sequences in this project.

importAEComps

25.0

boolean

Parameters

Name

Type

Description

aepPath

string

compNames

string[]

TargetBin

ProjectItem

importAllAEComps

25.0

boolean

Parameters

Name

Type

Description

aepPath

string

TargetBin

ProjectItem

importFiles

25.0

boolean

Import files in root/target bin of the project

Parameters

Name

Type

Description

filePaths

string[]

suppressUI

boolean

targetBin

ProjectItem

asNumberedStills

boolean

importSequences

25.0

boolean

Parameters

Name

Type

Description

projectPath

string

sequenceIds

Guid[]

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

Name

Type

Description

callback

() => void

openSequence

25.0

boolean

Open a sequence and return true if successful.

Parameters

Name

Type

Description

sequence

Sequence

pauseGrowing

25.0

boolean

Pause growing of files instead swap the files

Parameters

Name

Type

Description

pause

boolean

save

25.0

boolean

Save the project

saveAs

25.0

boolean

Save the project at the provided path

Parameters

Name

Type

Description

path

string

setActiveSequence

25.0

boolean

Set the active sequence of the project

Parameters

Name

Type

Description

sequence

Sequence