Project
Properties
| Name | Type | Access | Min Version | Description |
|---|---|---|---|---|
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.0Project
Create a new project
Parameters
| Name | Type | Description |
|---|---|---|
path | string | - |
getActiveProject
25.0Project
Currently active project.
getProject
25.0Project
Get project referenced by given UID
Parameters
| Name | Type | Description |
|---|---|---|
projectGuid | - |
open
25.0Project
Open a project
Parameters
| Name | Type | Description |
|---|---|---|
path | string | - |
openProjectOptions | - |
Instance Methods
close
25.0boolean
Close a project
Parameters
| Name | Type | Description |
|---|---|---|
closeProjectOptions | - |
createSequence
25.0Sequence
Create a new sequence with the default preset path - Parameter presetPath is deprecated, instead use createSequenceWithPresetPath()
Parameters
| Name | Type | Description |
|---|---|---|
name | string | - |
presetPath | string | - |
createSequenceFromMedia
25.0Sequence
Create a new sequence with a given name and medias
Parameters
| Name | Type | Description |
|---|---|---|
name | string | - |
clipProjectItems | - | |
targetBin | - |
deleteSequence
25.0boolean
Delete a given sequence from the project
Parameters
| Name | Type | Description |
|---|---|---|
sequence | - |
executeTransaction
25.0boolean
Execute undoable transaction by passing compound action
Parameters
| Name | Type | Description |
|---|---|---|
callback | (compoundAction: CompoundAction) => void | - |
undoString? | string | - |
getActiveSequence
25.0Sequence
Get the active sequence of the project
getColorSettings
25.0ProjectColorSettings
Get project color settings object
getInsertionBin
25.0ProjectItem
Get current insertion bin
getRootItem
25.0FolderItem
The root item of the project which contains all items of the project on the lowest level.
getSequence
25.0Sequence
Get sequence by id from the project
Parameters
| Name | Type | Description |
|---|---|---|
guid | - |
getSequences
25.0Sequence[]
Get an array of all sequences in this project.
importAEComps
25.0boolean
Parameters
| Name | Type | Description |
|---|---|---|
aepPath | string | - |
compNames | - | |
TargetBin | - |
importAllAEComps
25.0boolean
Parameters
| Name | Type | Description |
|---|---|---|
aepPath | string | - |
TargetBin | - |
importFiles
25.0boolean
Import files in root/target bin of the project
Parameters
| Name | Type | Description |
|---|---|---|
filePaths | - | |
suppressUI | boolean | - |
targetBin | - | |
asNumberedStills | boolean | - |
importSequences
25.0boolean
Parameters
| Name | Type | Description |
|---|---|---|
projectPath | string | - |
sequenceIds | - |
lockedAccess
25.0void
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.0boolean
Open a sequence and return true if successful.
Parameters
| Name | Type | Description |
|---|---|---|
sequence | - |
pauseGrowing
25.0boolean
Pause growing of files instead swap the files
Parameters
| Name | Type | Description |
|---|---|---|
pause | boolean | - |
save
25.0boolean
Save the project
saveAs
25.0boolean
Save the project at the provided path
Parameters
| Name | Type | Description |
|---|---|---|
path | string | - |
setActiveSequence
25.0boolean
Set the active sequence of the project
Parameters
| Name | Type | Description |
|---|---|---|
sequence | - |
