# Project Since: **25.6** ## Properties +---------------------------------------------------------------------------------------------------------------+ | Table | +:-----+:--------------------------------------------------------+:-------+:------------+:----------------------+ | Name | Type | Access | Min Version | Description | +:-----+:--------------------------------------------------------+:-------+:------------+:----------------------+ | guid | *[Guid](/premiere-pro/uxp/ppro-reference/classes/guid)* | R | 25.6 | The unique identifier | | | | | | of the project. | +:-----+:--------------------------------------------------------+:-------+:------------+:----------------------+ | name | *string* | R | 25.6 | The project name. | +:-----+:--------------------------------------------------------+:-------+:------------+:----------------------+ | path | *string* | R | 25.6 | The absolute file | | | | | | path to the project | | | | | | file. | +------+---------------------------------------------------------+--------+-------------+-----------------------+ ## Static Methods ### createProject Create a new project Since: **25.6** Returns: Promise<*[Project](/premiere-pro/uxp/ppro-reference/classes/project)*> #### Parameters +-------------------------------+ | Table | +:-----+:---------+:------------+ | Name | Type | Description | +:-----+:---------+:------------+ | path | *string* | \- | +------+----------+-------------+ +----------------+ | Horizontalline | +----------------+ | | +----------------+ ### getActiveProject Currently active project. Since: **25.6** Returns: Promise<*[Project](/premiere-pro/uxp/ppro-reference/classes/project)*> +----------------+ | Horizontalline | +----------------+ | | +----------------+ ### getProject Get project referenced by given UID Since: **25.6** Returns: *[Project](/premiere-pro/uxp/ppro-reference/classes/project)* #### Parameters +-------------------------------------------------------------------------------------+ | Table | +:------------+:--------------------------------------------------------+:------------+ | Name | Type | Description | +:------------+:--------------------------------------------------------+:------------+ | projectGuid | *[Guid](/premiere-pro/uxp/ppro-reference/classes/guid)* | \- | +-------------+---------------------------------------------------------+-------------+ +----------------+ | Horizontalline | +----------------+ | | +----------------+ ### isProject Returns true if the file at the given path is openable as a Premiere project Since: **26.2** Returns: *boolean* #### Parameters +--------------------------------------+ | Table | +:------------+:---------+:------------+ | Name | Type | Description | +:------------+:---------+:------------+ | projectPath | *string* | \- | +-------------+----------+-------------+ +----------------+ | Horizontalline | +----------------+ | | +----------------+ ### open Open a project Since: **25.6** Returns: Promise<*[Project](/premiere-pro/uxp/ppro-reference/classes/project)*> #### Parameters +------------------------------------------------------------------------------------------------------------------------+ | Table | +:-------------------+:------------------------------------------------------------------------------------+:------------+ | Name | Type | Description | +:-------------------+:------------------------------------------------------------------------------------+:------------+ | path | *string* | \- | +:-------------------+:------------------------------------------------------------------------------------+:------------+ | openProjectOptions | *[OpenProjectOptions](/premiere-pro/uxp/ppro-reference/classes/openprojectoptions)* | \- | +--------------------+-------------------------------------------------------------------------------------+-------------+ +----------------+ | Horizontalline | +----------------+ | | +----------------+ ## Instance Methods ### close Close a project Since: **25.6** Returns: Promise<*boolean*> #### Parameters +---------------------------------------------------------------------------------------------------------------------------+ | Table | +:--------------------+:--------------------------------------------------------------------------------------+:------------+ | Name | Type | Description | +:--------------------+:--------------------------------------------------------------------------------------+:------------+ | closeProjectOptions | *[CloseProjectOptions](/premiere-pro/uxp/ppro-reference/classes/closeprojectoptions)* | \- | +---------------------+---------------------------------------------------------------------------------------+-------------+ +----------------+ | Horizontalline | +----------------+ | | +----------------+ ### closeSequence Close a sequence and return true if successful. Since: **26.2** Returns: Promise<*boolean*> #### Parameters +------------------------------------------------------------------------------------------+ | Table | +:---------+:----------------------------------------------------------------+:------------+ | Name | Type | Description | +:---------+:----------------------------------------------------------------+:------------+ | sequence | *[Sequence](/premiere-pro/uxp/ppro-reference/classes/sequence)* | \- | +----------+-----------------------------------------------------------------+-------------+ +----------------+ | Horizontalline | +----------------+ | | +----------------+ ### createSequence Create a new sequence with the default preset path - Parameter presetPath is deprecated, instead use createSequenceWithPresetPath() Since: **25.6** Returns: Promise<*[Sequence](/premiere-pro/uxp/ppro-reference/classes/sequence)*> #### Parameters +-------------------------------------+ | Table | +:-----------+:---------+:------------+ | Name | Type | Description | +:-----------+:---------+:------------+ | name | *string* | \- | +:-----------+:---------+:------------+ | presetPath | *string* | \- | +------------+----------+-------------+ +----------------+ | Horizontalline | +----------------+ | | +----------------+ ### createSequenceFromMedia Create a new sequence with a given name and media Since: **25.6** Returns: Promise<*[Sequence](/premiere-pro/uxp/ppro-reference/classes/sequence)*> #### Parameters +--------------------------------------------------------------------------------------------------------------------+ | Table | +:-----------------+:----------------------------------------------------------------------------------+:------------+ | Name | Type | Description | +:-----------------+:----------------------------------------------------------------------------------+:------------+ | name | *string* | \- | +:-----------------+:----------------------------------------------------------------------------------+:------------+ | clipProjectItems | *[ClipProjectItem\[\]](/premiere-pro/uxp/ppro-reference/classes/clipprojectitem)* | \- | +:-----------------+:----------------------------------------------------------------------------------+:------------+ | targetBin | *[ProjectItem](/premiere-pro/uxp/ppro-reference/classes/projectitem)* | \- | +------------------+-----------------------------------------------------------------------------------+-------------+ +----------------+ | Horizontalline | +----------------+ | | +----------------+ ### createSequenceWithPresetPath Create a new sequence with a preset path Since: **26.3** Returns: Promise<*[Sequence](/premiere-pro/uxp/ppro-reference/classes/sequence)*> #### Parameters +-------------------------------------+ | Table | +:-----------+:---------+:------------+ | Name | Type | Description | +:-----------+:---------+:------------+ | name | *string* | \- | +:-----------+:---------+:------------+ | presetPath | *string* | \- | +------------+----------+-------------+ +----------------+ | Horizontalline | +----------------+ | | +----------------+ ### deleteSequence Delete a given sequence from the project Since: **25.6** Returns: Promise<*boolean*> #### Parameters +------------------------------------------------------------------------------------------+ | Table | +:---------+:----------------------------------------------------------------+:------------+ | Name | Type | Description | +:---------+:----------------------------------------------------------------+:------------+ | sequence | *[Sequence](/premiere-pro/uxp/ppro-reference/classes/sequence)* | \- | +----------+-----------------------------------------------------------------+-------------+ +----------------+ | Horizontalline | +----------------+ | | +----------------+ ### executeTransaction Execute undoable transaction by passing compound action Since: **25.6** Returns: *boolean* #### Parameters +------------------------------------------------------------------+ | Table | +:------------+:-------------------------------------+:------------+ | Name | Type | Description | +:------------+:-------------------------------------+:------------+ | callback | *(compoundAction: CompoundAction) => | \- | | | void* | | +:------------+:-------------------------------------+:------------+ | undoString? | *string* | \- | +-------------+--------------------------------------+-------------+ +----------------+ | Horizontalline | +----------------+ | | +----------------+ ### getActiveSequence Get the active sequence of the project Since: **25.6** Returns: Promise<*[Sequence](/premiere-pro/uxp/ppro-reference/classes/sequence)*> +----------------+ | Horizontalline | +----------------+ | | +----------------+ ### getColorSettings Get project color settings object Since: **25.6** Returns: Promise<*[ProjectColorSettings](/premiere-pro/uxp/ppro-reference/classes/projectcolorsettings)*> +----------------+ | Horizontalline | +----------------+ | | +----------------+ ### getInsertionBin Get current insertion bin Since: **25.6** Returns: Promise<*[ProjectItem](/premiere-pro/uxp/ppro-reference/classes/projectitem)*> +----------------+ | Horizontalline | +----------------+ | | +----------------+ ### getRootItem The root item of the project which contains all items of the project on the lowest level. Since: **25.6** Returns: Promise<*[FolderItem](/premiere-pro/uxp/ppro-reference/classes/folderitem)*> +----------------+ | Horizontalline | +----------------+ | | +----------------+ ### getSequence Get sequence by id from the project Since: **25.6** Returns: *[Sequence](/premiere-pro/uxp/ppro-reference/classes/sequence)* #### Parameters +------------------------------------------------------------------------------+ | Table | +:-----+:--------------------------------------------------------+:------------+ | Name | Type | Description | +:-----+:--------------------------------------------------------+:------------+ | guid | *[Guid](/premiere-pro/uxp/ppro-reference/classes/guid)* | \- | +------+---------------------------------------------------------+-------------+ +----------------+ | Horizontalline | +----------------+ | | +----------------+ ### getSequences Get an array of all sequences in this project. Since: **25.6** Returns: Promise<*[Sequence\[\]](/premiere-pro/uxp/ppro-reference/classes/sequence)*> +----------------+ | Horizontalline | +----------------+ | | +----------------+ ### importAEComps Since: **25.6** Returns: Promise<*boolean*> #### Parameters +-------------------------------------------------------------------------------------------------+ | Table | +:----------+:----------------------------------------------------------------------+:------------+ | Name | Type | Description | +:----------+:----------------------------------------------------------------------+:------------+ | aepPath | *string* | \- | +:----------+:----------------------------------------------------------------------+:------------+ | compNames | *string\[]* | \- | +:----------+:----------------------------------------------------------------------+:------------+ | targetBin | *[ProjectItem](/premiere-pro/uxp/ppro-reference/classes/projectitem)* | \- | +-----------+-----------------------------------------------------------------------+-------------+ +----------------+ | Horizontalline | +----------------+ | | +----------------+ ### importAllAEComps Since: **25.6** Returns: Promise<*boolean*> #### Parameters +-------------------------------------------------------------------------------------------------+ | Table | +:----------+:----------------------------------------------------------------------+:------------+ | Name | Type | Description | +:----------+:----------------------------------------------------------------------+:------------+ | aepPath | *string* | \- | +:----------+:----------------------------------------------------------------------+:------------+ | targetBin | *[ProjectItem](/premiere-pro/uxp/ppro-reference/classes/projectitem)* | \- | +-----------+-----------------------------------------------------------------------+-------------+ +----------------+ | Horizontalline | +----------------+ | | +----------------+ ### importFiles Import files in root/target bin of the project Since: **25.6** Returns: Promise<*boolean*> #### Parameters +--------------------------------------------------------------------------------------------------------+ | Table | +:-----------------+:----------------------------------------------------------------------+:------------+ | Name | Type | Description | +:-----------------+:----------------------------------------------------------------------+:------------+ | filePaths | *string\[]* | \- | +:-----------------+:----------------------------------------------------------------------+:------------+ | suppressUI | *boolean* | \- | +:-----------------+:----------------------------------------------------------------------+:------------+ | targetBin | *[ProjectItem](/premiere-pro/uxp/ppro-reference/classes/projectitem)* | \- | +:-----------------+:----------------------------------------------------------------------+:------------+ | asNumberedStills | *boolean* | \- | +------------------+-----------------------------------------------------------------------+-------------+ +----------------+ | Horizontalline | +----------------+ | | +----------------+ ### importSequences Since: **25.6** Returns: Promise<*boolean*> #### Parameters +-----------------------------------------------------------------------------------------+ | Table | +:------------+:------------------------------------------------------------+:------------+ | Name | Type | Description | +:------------+:------------------------------------------------------------+:------------+ | projectPath | *string* | \- | +:------------+:------------------------------------------------------------+:------------+ | sequenceIds | *[Guid\[\]](/premiere-pro/uxp/ppro-reference/classes/guid)* | \- | +-------------+-------------------------------------------------------------+-------------+ +----------------+ | Horizontalline | +----------------+ | | +----------------+ ### 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 +---------------------------------------+ | Table | +:---------+:-------------+:------------+ | Name | Type | Description | +:---------+:-------------+:------------+ | callback | *() => void* | \- | +----------+--------------+-------------+ +----------------+ | Horizontalline | +----------------+ | | +----------------+ ### openSequence Open a sequence and return true if successful. Since: **25.6** Returns: Promise<*boolean*> #### Parameters +------------------------------------------------------------------------------------------+ | Table | +:---------+:----------------------------------------------------------------+:------------+ | Name | Type | Description | +:---------+:----------------------------------------------------------------+:------------+ | sequence | *[Sequence](/premiere-pro/uxp/ppro-reference/classes/sequence)* | \- | +----------+-----------------------------------------------------------------+-------------+ +----------------+ | Horizontalline | +----------------+ | | +----------------+ ### 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 +---------------------------------+ | Table | +:------+:----------+:------------+ | Name | Type | Description | +:------+:----------+:------------+ | pause | *boolean* | \- | +-------+-----------+-------------+ +----------------+ | Horizontalline | +----------------+ | | +----------------+ ### save Save the project Since: **25.6** Returns: Promise<*boolean*> +----------------+ | Horizontalline | +----------------+ | | +----------------+ ### saveAs Save the project at the provided path Since: **25.6** Returns: Promise<*boolean*> #### Parameters +-------------------------------+ | Table | +:-----+:---------+:------------+ | Name | Type | Description | +:-----+:---------+:------------+ | path | *string* | \- | +------+----------+-------------+ +----------------+ | Horizontalline | +----------------+ | | +----------------+ ### setActiveSequence Set the active sequence of the project Since: **25.6** Returns: Promise<*boolean*> #### Parameters +------------------------------------------------------------------------------------------+ | Table | +:---------+:----------------------------------------------------------------+:------------+ | Name | Type | Description | +:---------+:----------------------------------------------------------------+:------------+ | sequence | *[Sequence](/premiere-pro/uxp/ppro-reference/classes/sequence)* | \- | +----------+-----------------------------------------------------------------+-------------+ +----------------+ | Horizontalline | +----------------+ | | +----------------+ +-----------------------------------------------------------------------------------------------------------------------+ | Metadata | +----------------+------------------------------------------------------------------------------------------------------+ | title | Project | +----------------+------------------------------------------------------------------------------------------------------+ | description | Overview of Project | +----------------+------------------------------------------------------------------------------------------------------+ | source | github | +----------------+------------------------------------------------------------------------------------------------------+ | pathprefix | /premiere-pro/uxp | +----------------+------------------------------------------------------------------------------------------------------+ | githubblobpath | https\://github.com/AdobeDocs/uxp-premiere-pro/blob/main/src/pages/ppro-reference/classes/project.md | +----------------+------------------------------------------------------------------------------------------------------+ | template | documentation | +----------------+------------------------------------------------------------------------------------------------------+