Premiere Pro Scripting

https://ppro-scripting.docsforadobe.dev
Admin
Premiere Pro Scripting provides an ExtendScript API allowing developers to automate workflows and...
Tokens:33,701
Snippets:442
Trust Score:7.5
Update:1 month ago
Show doc for...
Tokens:
Raw
### Get Learn Panel Example Projects Directory

Source: https://ppro-scripting.docsforadobe.dev/print_page

Retrieves the path to the directory containing Learn panel example projects.

```javascript
app.learnPanelExampleProjectDirPath;
// /Users/Shared/Adobe/Premiere Pro/14.0/Tutorial/Going Home project/
```

--------------------------------

### Get Learn panel directory paths

Source: https://ppro-scripting.docsforadobe.dev/application/application

Retrieves paths for the Learn panel's content or example projects directories.

```javascript
app.learnPanelContentDirPath;
// /Users/Shared/Adobe/Premiere Pro 2020/Learn Panel/
```

```javascript
app.learnPanelExampleProjectDirPath;
// /Users/Shared/Adobe/Premiere Pro/14.0/Tutorial/Going Home project/
```

--------------------------------

### ProjectItem.startTime()

Source: https://ppro-scripting.docsforadobe.dev/item/projectitem

Returns the start time of the project item.

```APIDOC
## ProjectItem.startTime()

### Description
Returns a Time object, representing start time.

### Returns
- **Time object** - The start time.
```

--------------------------------

### ProjectItem.setStartTime()

Source: https://ppro-scripting.docsforadobe.dev/item/projectitem

Assigns a new start time to the project item.

```APIDOC
## ProjectItem.setStartTime()

### Description
Assigns a new start time to the project item.

### Parameters
- **time** (String) - Required - A new starting time, represented in ticks.

### Returns
- **0** (Integer) - Returned if successful.
```

--------------------------------

### SourceMonitor.play()

Source: https://ppro-scripting.docsforadobe.dev/general/sourcemonitor

Starts playback in the Source monitor at a specified speed.

```APIDOC
## SourceMonitor.play(playbackSpeed)

### Description
Begins playing back the Source monitor, at the specified playback speed.

### Parameters
- **playbackSpeed** (Float) - Required - The playback speed.

### Returns
- **result** (Integer) - Returns 0 if successful.
```

--------------------------------

### Get Application System Preference Path

Source: https://ppro-scripting.docsforadobe.dev/print_page

Retrieves the path to the system-wide configuration files.

```javascript
app.getAppSystemPrefPath;
// /Library/Application Support/Adobe/Adobe Premiere Pro 2020/
```

--------------------------------

### Sequence.setZeroPoint()

Source: https://ppro-scripting.docsforadobe.dev/sequence/sequence

Set the starting time of the sequence.

```APIDOC
## Sequence.setZeroPoint()

### Description
Set the starting time of the sequence.

### Signature
`app.project.sequences[index].setZeroPoint(newZeroPoint)`

### Parameters
- **newZeroPoint** (String) - Required - The new zero point in ticks.

### Returns
- **Boolean** - true if successful.
```

--------------------------------

### Get Learn Panel Content Directory

Source: https://ppro-scripting.docsforadobe.dev/print_page

Retrieves the path to the directory containing Learn panel content.

```javascript
app.learnPanelContentDirPath;
// /Users/Shared/Adobe/Premiere Pro 2020/Learn Panel/
```

--------------------------------

### Get application system configuration path

Source: https://ppro-scripting.docsforadobe.dev/application/application

Retrieves the file system path to the non-user-specific configuration directory.

```javascript
app.getAppSystemPrefPath;
// /Library/Application Support/Adobe/Adobe Premiere Pro 2020/
```

```javascript
app.getPProSystemPrefPath;
// /Library/Application Support/Adobe/Adobe Premiere Pro 2020/
```

--------------------------------

### Get current project path

Source: https://ppro-scripting.docsforadobe.dev/general/project

Retrieves the file system path of the currently active project.

```javascript
app.project.path; // /Users/USERNAME/Desktop/Project.prproj
```

--------------------------------

### Get application version

Source: https://ppro-scripting.docsforadobe.dev/application/application

Retrieves the version string of the currently running Premiere Pro application.

```javascript
app.version; // 14.3.1
```

--------------------------------

### Get Premiere Pro System Preference Path

Source: https://ppro-scripting.docsforadobe.dev/print_page

Retrieves the path to the system-wide Premiere Pro configuration folder.

```javascript
app.getPProSystemPrefPath;
// /Library/Application Support/Adobe/Adobe Premiere Pro 2020/
```

--------------------------------

### Get application preference path

Source: https://ppro-scripting.docsforadobe.dev/application/application

Retrieves the file system path to the active user preference directory.

```javascript
app.getAppPrefPath;
// /Users/USERNAME/Documents/Adobe/Premiere Pro/14.0/Profile-USERNAME/
```

```javascript
app.getPProPrefPath;
// /Users/USERNAME/Documents/Adobe/Premiere Pro/14.0/Profile-USERNAME/
```

--------------------------------

### Get Application Preference Path

Source: https://ppro-scripting.docsforadobe.dev/print_page

Retrieves the file system path to the active user preference file.

```javascript
app.getAppPrefPath;
// /Users/USERNAME/Documents/Adobe/Premiere Pro/14.0/Profile-USERNAME/
```

--------------------------------

### ProjectItem.name

Source: https://ppro-scripting.docsforadobe.dev/item/projectitem

Gets or sets the name of the project item.

```APIDOC
## ProjectItem.name

### Description
The name of the project item.

### Type
String; read/write.

### Example
```javascript
var item = app.project.rootItem.children[0];
if (item) {
    item.name = item.name + ', updated by PProPanel.';
} else {
    alert('Could not rename project item');
}
```
```

--------------------------------

### Get application executable path

Source: https://ppro-scripting.docsforadobe.dev/application/application

Retrieves the file system path to the Premiere Pro application executable.

```javascript
app.path;
// /Applications/Adobe Premiere Pro 2020/Adobe Premiere Pro 2020.app/
```

--------------------------------

### Get Available Workspaces

Source: https://ppro-scripting.docsforadobe.dev/application/application

Retrieves an array of strings representing the names of all available workspaces.

```javascript
app.getWorkspaces();
/* [
    "All Panels",
    "Assembly",
    "Audio",
    "Color",
    "Editing",
    "Effects",
    "Graphics",
    "Learning",
    "Libraries",
    "Metalogging",
    "Production"
]; */
```

--------------------------------

### Get application build version

Source: https://ppro-scripting.docsforadobe.dev/application/application

Retrieves the build number of the currently running Premiere Pro instance.

```javascript
// in Adobe Premiere Pro version 14.3.1 (Build 45)...
parseInt(app.build); // 45
```

--------------------------------

### Get Premiere Pro Preference Path

Source: https://ppro-scripting.docsforadobe.dev/print_page

Retrieves the path to the active Premiere Pro preference file.

```javascript
app.getPProPrefPath;
// /Users/USERNAME/Documents/Adobe/Premiere Pro/14.0/Profile-USERNAME/
```

--------------------------------

### Get Current Project View Selection

Source: https://ppro-scripting.docsforadobe.dev/application/application

Returns an array of currently selected ProjectItems in the active project view.

```javascript
var selectedItems = app.getCurrentProjectViewSelection();
if (selectedItems){
    var firstOne = selectedItems[0];
} else {
    // No projectItems selected.
}
```

--------------------------------

### app.enableQE()

Source: https://ppro-scripting.docsforadobe.dev/application/application

Enables the Premiere Pro QE DOM.

```APIDOC
## app.enableQE()

### Description
Enables Premiere Pro's QE DOM.

### Returns
- **Boolean** - Returns true if QE DOM was enabled.
```

--------------------------------

### ProjectItem.createSmartBin()

Source: https://ppro-scripting.docsforadobe.dev/item/projectitem

Creates a search bin for bin project items.

```APIDOC
## ProjectItem.createSmartBin(name, queryString)

### Description
Creates a search bin; only works for bin project items.

### Parameters
- **name** (String) - Required - A name of a new bin.
- **queryString** (String) - Required - Query string for search.

### Returns
- **result** (ProjectItem) - Returns a projectItem representing the newly-created bin, if successful.
```

--------------------------------

### Encoder.startBatch()

Source: https://ppro-scripting.docsforadobe.dev/general/encoder

Initiates the rendering of the current Adobe Media Encoder queue.

```APIDOC
## Encoder.startBatch()

### Description
Makes Adobe Media Encoder start rendering its render queue.

### Returns
- **status** (Integer) - Returns 0 if successful.
```

--------------------------------

### Marker.getColorByIndex()

Source: https://ppro-scripting.docsforadobe.dev/general/marker

Gets the marker color index.

```APIDOC
## Marker.getColorByIndex(index)

### Description
Gets the marker color index. This functionality was added in Adobe Premiere Pro 13.x.

### Parameters
- **index** (Integer) - Required - Index of the marker to be read.

### Returns
- **Integer** - The color index.
```

--------------------------------

### Anywhere.openProduction()

Source: https://ppro-scripting.docsforadobe.dev/general/anywhere

Opens the production at the specified URL.

```APIDOC
## Anywhere.openProduction(productionURL)

### Description
Opens the production at the specified URL.

### Parameters
- **productionURL** (String) - Required - The url of the production to open.

### Returns
Returns 0 if successful.
```

--------------------------------

### TrackItem.disabled

Source: https://ppro-scripting.docsforadobe.dev/item/trackitem

Sets or gets the disabled state of the TrackItem.

```APIDOC
## TrackItem.disabled

### Description
Sets the disabled state of the TrackItem. Read/Write.

### Parameters
- **newDisableState** (Boolean) - Required - If true, this TrackItem will be disabled; if false, enabled.

### Returns
- **Integer** - 0 if successful.
```

--------------------------------

### Project.importFiles()

Source: https://ppro-scripting.docsforadobe.dev/general/project

Imports media files into the project.

```APIDOC
## Project.importFiles(filePaths, suppressUI, targetBin, importAsNumberedStills)

### Description
Imports media from the specified file paths.

### Parameters
- **filePaths** (Array of strings) - An array of the file paths to be imported.
- **suppressUI** (Boolean) - Whether warning dialogs should be suppressed.
- **targetBin** (ProjectItem object) - The bin into which the files should be imported.
- **importAsNumberedStills** (Boolean) - Whether the file paths should be interpreted as a sequence of numbered stills.

### Returns
Returns true if successful, false if not.
```

--------------------------------

### ProjectItem.createBin()

Source: https://ppro-scripting.docsforadobe.dev/item/projectitem

Creates an empty bin within the project item.

```APIDOC
## ProjectItem.createBin(name)

### Description
Creates an empty bin within the project item. Only works within bins.

### Parameters
- **name** (String) - Required - A name of a new bin.

### Returns
- **result** (ProjectItem) - Returns a project item representing the new bin if successful, or 0 if unsuccessful.
```

--------------------------------

### Project.importAllAEComps()

Source: https://ppro-scripting.docsforadobe.dev/print_page

Imports all compositions from an After Effects .aep project file.

```APIDOC
## Project.importAllAEComps()

### Description
Imports all Compositions from the containing After Effects .aep project file.

### Parameters
- **path** (String) - Required - A path to After Effects .aep project file.
- **targetBin** (ProjectItem object) - Optional - The destination bin for this import.

### Returns
- Returns 0 if successful.
```

--------------------------------

### Production.addProject()

Source: https://ppro-scripting.docsforadobe.dev/general/production

Copies a project from a specified location into the Production directory.

```APIDOC
## Production.addProject(srcProjectPath, destProjectPath)

### Description
Copies a project from some other location into the Production directory.

### Parameters
- **srcProjectPath** (String) - Required - A path to the source project.
- **destProjectPath** (String) - Required - A destination path for added project.

### Returns
- **Boolean** - Returns true if successful.
```

--------------------------------

### Sequence.getSettings()

Source: https://ppro-scripting.docsforadobe.dev/sequence/sequence

Retrieves the settings of the current sequence as a structure.

```APIDOC
## Sequence.getSettings()

### Description
Retrieves the settings of the current sequence.

### Returns
Returns an object containing sequence settings such as audioChannelCount, audioChannelType, audioDisplayFormat, audioSampleRate, autoToneMapEnabled, compositeLinearColor, editingMode, maximumBitDepth, maximumRenderQuality, previewCodec, previewFrameWidth, previewFrameHeight, previewFileFormat, videoDisplayFormat, videoFieldType, videoFrameHeight, videoFrameWidth, videoPixelAspectRatio, vrHorzCapturedView, vrVertCapturedView, vrLayout, and vrProjection.
```

--------------------------------

### Project.getInsertionBin()

Source: https://ppro-scripting.docsforadobe.dev/print_page

Returns a ProjectItem object referencing the bin into which import will occur.

```APIDOC
## Project.getInsertionBin()

### Description
Returns a ProjectItem object referencing the bin into which import will occur.

### Returns
- Returns a ProjectItem object if successful, 0 if not.
```

--------------------------------

### app.newProject()

Source: https://ppro-scripting.docsforadobe.dev/application/application

Creates a new .prproj Project object.

```APIDOC
## app.newProject(path)

### Description
Creates a new .prproj Project object, at the specified path.

### Parameters
- **path** (String) - Required - A full path to new project; a .prproj extension will not be added.

### Returns
- **Boolean** - Returns true if successful.
```

--------------------------------

### SourceMonitor.openProjectItem()

Source: https://ppro-scripting.docsforadobe.dev/general/sourcemonitor

Opens a project item into the Source monitor.

```APIDOC
## SourceMonitor.openProjectItem(projectItem)

### Description
Open a project item in the Source monitor.

### Parameters
- **projectItem** (ProjectItem) - Required - A project item to open.

### Returns
- **result** (Integer) - Returns 0 if successful.
```

--------------------------------

### Sequence.importMGTFromLibrary()

Source: https://ppro-scripting.docsforadobe.dev/sequence/sequence

Imports a Motion Graphics Template (MOGRT) from a Creative Cloud Library into the sequence.

```APIDOC
## Sequence.importMGTFromLibrary(libraryName, mgtName, time, vidTrackOffset, audTrackOffset)

### Description
Imports a MOGRT from the current user's Creative Cloud Libraries to the specified video or audio track at a given time.

### Parameters
- **libraryName** (String) - Required - The name of the Library.
- **mgtName** (String) - Required - The name of the .mogrt file.
- **time** (String) - Required - The time in ticks to insert the .mogrt.
- **vidTrackOffset** (Integer) - Required - Track offset from the zero-th video track.
- **audTrackOffset** (Integer) - Required - Track offset from the zero-th audio track.

### Returns
- **TrackItem** (Object) - The imported track item.
```

--------------------------------

### ProjectItem.moveBin()

Source: https://ppro-scripting.docsforadobe.dev/item/projectitem

Moves the projectItem into a new parent bin.

```APIDOC
## ProjectItem.moveBin(newParentBinProjectItem)

### Description
Moves the projectItem into a new parent bin.

### Returns
- **Integer** - Returns 0 if move was successful.
```

--------------------------------

### Get Project from View ID

Source: https://ppro-scripting.docsforadobe.dev/application/application

Retrieves the Project object associated with a specific view ID obtained from getProjectViewIDs.

```javascript
var allViewIDs = app.getProjectViewIDs();
if (allViewIDs){
    var firstOne = allViewIDs[0];
    if (firstOne){
        var thisProject = getProjectFromViewID(firstOne);
        if (thisProject){
            var name = thisProject.name;
        } else {
            // no project associated with that view ID.
        }
} else {
    // No views open.
}
```

--------------------------------

### Project.createNewSequenceFromClips()

Source: https://ppro-scripting.docsforadobe.dev/general/project

Creates a new Sequence object and inserts project items into it.

```APIDOC
## Project.createNewSequenceFromClips(sequenceName, arrayOfProjectItems, [destinationBin])

### Description
Creates a new Sequence object with the given name, in the specified destination bin, and sequentially inserts project items into it.

### Parameters
- **sequenceName** (String) - Optional - A name for a new sequence.
- **arrayOfProjectItems** (Array of ProjectItem objects) - Required - An array of project items to be inserted into sequence.
- **destinationBin** (ProjectItem object) - Optional - A bin to contain sequence.

### Returns
Returns the newly-created Sequence object if successful; 0 if unsuccessful.
```

--------------------------------

### Project.newBarsAndTone()

Source: https://ppro-scripting.docsforadobe.dev/print_page

Creates a new Sequence object with bars and tone.

```APIDOC
## Project.newBarsAndTone(width, height, timeBase, PARNum, PARDen, audioSampleRate, name)

### Description
Creates a new Sequence object with the given name, based on the specified preset.

### Parameters
- **width** (Integer)
- **height** (Integer)
- **timeBase** (Unknown) - A timebase for a new project item.
- **PARNum** (Integer) - Pixel aspect ration numerator.
- **PARDen** (Integer) - Pixel aspect ration denominator.
- **audioSampleRate** (Unknown) - Audio sample rate.
- **name** (String) - Name for a new project item.

### Returns
- Returns a ProjectItem object for the new bars and tone, or 0 if unsuccessful.
```

--------------------------------

### ProjectItem.attachProxy()

Source: https://ppro-scripting.docsforadobe.dev/item/projectitem

Attaches media to a project item as either hi-res or proxy media.

```APIDOC
## ProjectItem.attachProxy(mediaPath, isHiRes)

### Description
Attaches the media at mediaPath to the project item, as either hi-res or proxy media.

### Parameters
- **mediaPath** (String) - Required - The path to the newly-assigned media.
- **isHiRes** (Integer) - Required - Whether the new media should be attached as the proxy (0) or high resolution (1) media.

### Returns
- **result** (Integer) - Returns 0 if successful.
```

--------------------------------

### Project.openSequence()

Source: https://ppro-scripting.docsforadobe.dev/print_page

Opens a specific sequence in the Timeline panel.

```APIDOC
## Project.openSequence(sequenceID)

### Description
Makes the Sequence object with the provided sequence ID, active. This will open the sequence in the Timeline panel.

### Parameters
- **sequenceID** (Sequence.sequenceID) - A valid sequence ID that should be opened.

### Returns
- Returns true if successful, false if not.
```

--------------------------------

### Encoder.launchEncoder()

Source: https://ppro-scripting.docsforadobe.dev/general/encoder

Launches the Adobe Media Encoder application.

```APIDOC
## Encoder.launchEncoder()

### Description
Launches Adobe Media Encoder.

### Returns
- **status** (Integer) - Returns 0 if successful.
```

--------------------------------

### Sequence.importMGT()

Source: https://ppro-scripting.docsforadobe.dev/sequence/sequence

Imports a MOGRT file to the specified video or audio track at a given time.

```APIDOC
## Sequence.importMGT()

### Description
Imports a MOGRT, or an After Effects Motion Graphics Template, to the specified video or audio track, at the specified time.

### Parameters
- **path** (String) - Required - Full path to a valid MOGRT (.mogrt file), created in After Effects.
- **time** (String) - Required - The time at which to insert .mogrt, in ticks.
- **vidTrackOffset** (Integer) - Required - How many tracks from the zero-th video track, into which to insert .mogrt content.
- **audTrackOffset** (Integer) - Required - How many tracks from the zero-th audio track, into which to insert .mogrt content.

### Returns
Returns a TrackItem object.
```

--------------------------------

### ProjectItem.findItemsMatchingMediaPath()

Source: https://ppro-scripting.docsforadobe.dev/item/projectitem

Finds project items referencing the same media path.

```APIDOC
## ProjectItem.findItemsMatchingMediaPath(pathToMatch, ignoreSubClips)

### Description
Returns an array of project items, all of which reference the same media path.

### Parameters
- **pathToMatch** (String) - Required - A path to match.
- **ignoreSubClips** (Integer) - Required - If 1, no subclips will be returned.

### Returns
- **result** (Array) - Returns an array of project items, or 0 if no project items matching the matchPath were found.
```

--------------------------------

### app.path

Source: https://ppro-scripting.docsforadobe.dev/print_page

Retrieves the file system path to the Premiere Pro executable file.

```APIDOC
## app.path

### Description
Get a path to applications executable file.

### Type
String; read-only.
```

--------------------------------

### Project.newBarsAndTone()

Source: https://ppro-scripting.docsforadobe.dev/general/project

Creates a new Sequence object with the given name, based on the specified preset.

```APIDOC
## Project.newBarsAndTone(width, height, timeBase, PARNum, PARDen, audioSampleRate, name)

### Description
Creates a new Sequence object with the given name, based on the specified preset (.sqpreset file).

### Parameters
- **width** (Integer) - Required
- **height** (Integer) - Required
- **timeBase** (Unknown) - Required - A timebase for a new project item.
- **PARNum** (Integer) - Required - Pixel aspect ration numerator.
- **PARDen** (Integer) - Required - Pixel aspect ration denominator.
- **audioSampleRate** (Unknown) - Required - Audio sample rate.
- **name** (String) - Required - Name for a new project item.

### Returns
- Returns a ProjectItem object for the new bars and tone, or 0 if unsuccessful.
```

--------------------------------

### ProjectItem.setOutPoint()

Source: https://ppro-scripting.docsforadobe.dev/item/projectitem

Sets the out point for specified media types.

```APIDOC
## ProjectItem.setOutPoint()

### Description
Sets the out point to `seconds`, for specified media types.

### Parameters
- **seconds** (Integer) - Required - A time in seconds.
- **mediaType** (Integer) - Required - Determining which media type to affect; pass 1 for video only, 2 for audio only, or 4 for all media types.

### Returns
- **0** (Integer) - Returned if successful.
```

--------------------------------

### app.openFCPXML()

Source: https://ppro-scripting.docsforadobe.dev/application/application

Opens an FCP XML file as a Premiere Pro Project object.

```APIDOC
## app.openFCPXML(path, projPath)

### Description
Opens an FCP XML file as a Premiere Pro Project object (specified in projPath).

### Parameters
- **path** (String) - Required
- **projPath** (String) - Required

### Returns
- **Boolean** - Returns true if file was successfully opened as a Premiere Pro Project object.
```

--------------------------------

### Sequence.exportAsProject()

Source: https://ppro-scripting.docsforadobe.dev/sequence/sequence

Creates a new project containing only the given sequence and its media.

```APIDOC
## Sequence.exportAsProject(outputPath)

### Description
Creates a new Project object containing only the given sequence and its constituent media.

### Parameters
- **outputPath** (String) - Required - The output path for the new project.

### Returns
- **Boolean** - true if successful.
```

--------------------------------

### Project.newSequence()

Source: https://ppro-scripting.docsforadobe.dev/general/project

Creates a new Sequence object with the given name, based on the specified preset.

```APIDOC
## Project.newSequence(name, pathToSequencePreset)

### Description
Creates a new Sequence object with the given name, based on the specified preset (.sqpreset file).

### Parameters
- **name** (String) - Required - Name for a new sequence.
- **pathToSequencePreset** (String) - Required - A path to a preset .sqpreset file.

### Returns
- Returns a Sequence object, or 0 if unsuccessful.
```

--------------------------------

### app.getAppSystemPrefPath

Source: https://ppro-scripting.docsforadobe.dev/print_page

Retrieves the file system path to the active system-wide configuration files.

```APIDOC
## app.getAppSystemPrefPath

### Description
Premiere Pro's active configuration files, not specific to a given user.

### Type
String; read-only.
```

--------------------------------

### ProjectItem.getOutPoint()

Source: https://ppro-scripting.docsforadobe.dev/item/projectitem

Retrieves the current out point for the specified media type.

```APIDOC
## ProjectItem.getOutPoint(mediaType)

### Description
Retrieves the current out point for specified media type.

### Parameters
- **mediaType** (Integer) - Optional - Pass 1 for video only, or 2 for audio only. If no mediaType is passed, function gets the out point for all media.

### Returns
- **Time** (Object) - Returns a Time object.
```

--------------------------------

### ProjectItem.select()

Source: https://ppro-scripting.docsforadobe.dev/item/projectitem

Sets the project item as the target for subsequent imports.

```APIDOC
## ProjectItem.select()

### Description
Sets the project item (which must be a bin) as the target for subsequent imports into the project.

### Returns
- **0** (Integer) - Returned if the project item has successfully been made the target.
```

--------------------------------

### SourceMonitor.openFilePath()

Source: https://ppro-scripting.docsforadobe.dev/general/sourcemonitor

Opens a specific file from the file system into the Source monitor.

```APIDOC
## SourceMonitor.openFilePath(path)

### Description
Open a file in the Source monitor.

### Parameters
- **path** (String) - Required - A path to the file to open.

### Returns
- **success** (Boolean) - Returns true if successful.
```

--------------------------------

### app.openDocument()

Source: https://ppro-scripting.docsforadobe.dev/application/application

Opens the file at the specified path as a Premiere Pro Project object.

```APIDOC
## app.openDocument(path, [suppressConversionDialog], [bypassLocateFileDialog], [bypassWarningDialog], [doNotAddToMRUList])

### Description
Opens the file at the specified path, as a Premiere Pro Project object.

### Parameters
- **path** (String) - Required - Full path to the document to be opened.
- **suppressConversionDialog** (Boolean) - Optional - Suppress project conversion dialog.
- **bypassLocateFileDialog** (Boolean) - Optional - Bypass the locate file dialog.
- **bypassWarningDialog** (Boolean) - Optional - Bypass warning dialog.
- **doNotAddToMRUList** (Boolean) - Optional - Skip adding this file to the Most Recently Used List.

### Returns
- **Boolean** - Returns true if file was successfully opened.
```

--------------------------------

### Rename Project Item

Source: https://ppro-scripting.docsforadobe.dev/item/projectitem

Demonstrates how to access the first project item and modify its name property.

```javascript
var item = app.project.rootItem.children[0];
if (item) {
    item.name = item.name + ', updated by PProPanel.';
} else {
    alert('Could not rename project item');
}
```

--------------------------------

### ProjectItem.createSubClip()

Source: https://ppro-scripting.docsforadobe.dev/item/projectitem

Creates a new project item for a sub-clip.

```APIDOC
## ProjectItem.createSubClip(name, startTime, endTime, hasHardBoundaries, takeAudio, takeVideo)

### Description
Creates a new project item for a sub-clip of the existing project item.

### Parameters
- **name** (String) - Required - A name of a new subclip.
- **startTime** (String) - Required - Start time of subclip, in ticks.
- **endTime** (String) - Required - End time of subclip, in ticks.
- **hasHardBoundaries** (Integer) - Required - If 1, the user cannot extend in and out.
- **takeAudio** (Integer) - Required - If 1, use audio from source.
- **takeVideo** (Integer) - Required - If 1, use video from source.

### Returns
- **result** (ProjectItem) - Returns a project item representing the new subclip, or 0 if creation failed.
```

--------------------------------

### app.trace()

Source: https://ppro-scripting.docsforadobe.dev/application/application

Writes a string to Premiere Pro's debug console.

```APIDOC
## app.trace()

### Description
Writes a string to Premiere Pro's debug console.

### Returns
- **Boolean** - Returns true if trace was added.
```

--------------------------------

### Sequence.linkSelection()

Source: https://ppro-scripting.docsforadobe.dev/sequence/sequence

Links selected video and audio clips.

```APIDOC
## Sequence.linkSelection()

### Description
Links the selected video and audio clips in the sequence.

### Returns
- **Boolean** - True if successful.
```

--------------------------------

### Sequence.createCaptionTrack()

Source: https://ppro-scripting.docsforadobe.dev/sequence/sequence

Creates a caption track in the sequence using caption data from a ProjectItem object.

```APIDOC
## Sequence.createCaptionTrack()

### Description
Creates a caption track in the sequence using caption data from a ProjectItem object.

### Parameters
- **projectItem** (ProjectItem object) - Required - A captions source clip (e.g. .srt)
- **startAtTime** (Float) - Required - Offset in seconds from start of sequence
- **captionFormat** (Sequence.CAPTION_FORMAT_ enum) - Optional - Caption format of the new track. Default is Sequence.CAPTION_FORMAT_SUBTITLE.
```

--------------------------------

### app.project

Source: https://ppro-scripting.docsforadobe.dev/general/project

The Project object represents a Premiere Pro project. Multiple projects may be open simultaneously.

```APIDOC
## app.project

### Description
Represents a Premiere Pro project. As of Premiere Pro 12.0, multiple projects may be open at the same time.

### Attributes
- **activeSequence** (Sequence) - The currently active Sequence object, or 0 if none is active.
- **cloudProjectlocalID** (String) - The ID of the cloud project (read-only).
- **documentID** (String) - A unique identifier for the project in UUID format (read-only).
- **isCloudProject** (Boolean) - Indicates if the project is a cloud project (read-only).
- **name** (String) - The name of the project (read-only).
- **path** (String) - The file path of the project (read-only).
- **rootItem** (ProjectItem) - The root ProjectItem object of the project.
- **sequences** (SequenceCollection) - The sequences within the project (read-only).
```

--------------------------------

### Project.getSupportedGraphicsWhiteLuminances()

Source: https://ppro-scripting.docsforadobe.dev/print_page

Retrieves the supported graphics white luminance values for the project.

```APIDOC
## Project.getSupportedGraphicsWhiteLuminances()

### Description
Retrieves the supported graphics white luminance values, for this project.

### Returns
- Returns an array of graphics white settings supported by the project.
```

--------------------------------

### ProjectItem.setScaleToFrameSize()

Source: https://ppro-scripting.docsforadobe.dev/item/projectitem

Turns on scaling to frame size.

```APIDOC
## ProjectItem.setScaleToFrameSize()

### Description
Turns on scaling to frame size, for when media from this project item is inserted into a sequence.

### Returns
- **Undefined** - Undefined return value.
```

--------------------------------

### Application Metadata and Paths

Source: https://ppro-scripting.docsforadobe.dev/application/application

Properties providing access to application versioning, build numbers, and system file paths.

```APIDOC
## app.build
- **Type**: String (read-only)
- **Description**: The build number of the running Premiere Pro instance.

## app.version
- **Type**: String (read-only)
- **Description**: The version of Premiere Pro providing the API.

## app.path
- **Type**: String (read-only)
- **Description**: The path to the application's executable file.

## app.getAppPrefPath
- **Type**: String (read-only)
- **Description**: The path containing the currently active 'Adobe Premiere Pro Prefs' file.

## app.getAppSystemPrefPath
- **Type**: String (read-only)
- **Description**: Premiere Pro's active configuration files, not specific to a given user.
```

--------------------------------

### ProjectItem.setInPoint()

Source: https://ppro-scripting.docsforadobe.dev/item/projectitem

Sets the in point for specified media types.

```APIDOC
## ProjectItem.setInPoint()

### Description
Sets the in point to `seconds`, for specified media types.

### Parameters
- **seconds** (Integer) - Required - A time in ticks.
- **mediaType** (Integer) - Required - Determining which media type to affect; pass 1 for video only, 2 for audio only, or 4 for all media types.

### Returns
- **0** (Integer) - Returned if successful.
```

--------------------------------

### app.getAppPrefPath

Source: https://ppro-scripting.docsforadobe.dev/print_page

Retrieves the file system path to the currently active Adobe Premiere Pro preferences file.

```APIDOC
## app.getAppPrefPath

### Description
The path containing the currently active "Adobe Premiere Pro Prefs" file.

### Type
String; read-only.
```

--------------------------------

### Anywhere.listProductions()

Source: https://ppro-scripting.docsforadobe.dev/general/anywhere

Retrieves production names available to the current user.

```APIDOC
## Anywhere.listProductions()

### Description
Retrieves production names, available to the current user, on the current server.

### Returns
Returns an Array of Strings containing the names of available productions, or 0 if unsuccessful.
```

--------------------------------

### app.setScratchDiskPath()

Source: https://ppro-scripting.docsforadobe.dev/application/application

Specifies the path to be used for one of Premiere Pro's scratch disk paths.

```APIDOC
## app.setScratchDiskPath(path, scratchDiskType)

### Description
Specifies the path to be used for one of Premiere Pro's scratch disk paths.

### Parameters
- **path** (String) - The new path to be used.
- **scratchDiskType** (ScratchDiskType) - Enumerated value (FirstVideoCaptureFolder, FirstAudioCaptureFolder, FirstVideoPreviewFolder, FirstAudioPreviewFolder, FirstAutoSaveFolder, FirstCCLibrariesFolder, FirstCapsuleMediaFolder).

### Returns
- **Boolean** - Returns true if successful.
```

--------------------------------

### ProjectItem.getXMPMetadata()

Source: https://ppro-scripting.docsforadobe.dev/item/projectitem

Retrieves the XMP metadata associated with the project item.

```APIDOC
## ProjectItem.getXMPMetadata()

### Description
Retrieves the XMP metadata associated with the project item, as a String.

### Returns
- **String** - A String containing all XMP metadata, serialized.
```

--------------------------------

### Project.save()

Source: https://ppro-scripting.docsforadobe.dev/general/project

Saves the project at its current path.

```APIDOC
## Project.save()

### Description
Saves the project, at its current path.

### Returns
- Returns 0 if successful.
```

--------------------------------

### Production.moveToTrash()

Source: https://ppro-scripting.docsforadobe.dev/general/production

Moves a specified path or project file into the Production's Trash folder.

```APIDOC
## Production.moveToTrash(projectOrFolderPath, suppressUI, saveProject)

### Description
Moves the specified path (bin) or .prproj into the Production's Trash folder.

### Parameters
- **projectOrFolderPath** (String) - Required - A path to the source project.
- **suppressUI** (Boolean) - Required - Whether to suppress any resultant dialogues.
- **saveProject** (Boolean) - Required - Whether to save the project(s) first.

### Returns
- **Boolean** - Returns true if successful.
```

--------------------------------

### app.setWorkspace()

Source: https://ppro-scripting.docsforadobe.dev/application/application

Set workspace as active.

```APIDOC
## app.setWorkspace(workspace)

### Description
Set workspace as active. Use app.getWorkspaces() to get a list of all available workspaces.

### Parameters
- **workspace** (String) - The name of the workspace.

### Returns
- **Boolean** - Returns true if successful.
```

--------------------------------

### app.getWorkspaces()

Source: https://ppro-scripting.docsforadobe.dev/application/application

Obtains an array of available workspaces.

```APIDOC
## app.getWorkspaces()

### Description
Obtains an array of available workspaces as Strings.

### Returns
- **Array** - Array of strings if successful, null if unsuccessful.
```

--------------------------------

### Project.getProjectPanelMetadata()

Source: https://ppro-scripting.docsforadobe.dev/print_page

Returns the current layout of the Project panel.

```APIDOC
## Project.getProjectPanelMetadata()

### Description
Returns the current layout of the Project panel.

### Returns
- Returns a String representing the current Project panel layout, or 0 if unsuccessful.
```

--------------------------------

### SourceMonitor.getProjectItem()

Source: https://ppro-scripting.docsforadobe.dev/general/sourcemonitor

Retrieves the project item associated with the media currently open in the Source monitor.

```APIDOC
## SourceMonitor.getProjectItem()

### Description
Retrieves the project item corresponding to the media open in the Source monitor.

### Returns
- **item** (ProjectItem) - Returns projectItem if successful; null if not.
```

--------------------------------

### ProjectItem.getProjectMetadata()

Source: https://ppro-scripting.docsforadobe.dev/item/projectitem

Retrieves metadata associated with the project item, distinct from media XMP.

```APIDOC
## ProjectItem.getProjectMetadata()

### Description
Retrieves metadata associated with the project item. Distinct from media XMP.

### Returns
- **String** - A String containing all Premiere Pro private project metadata, serialized.
```

--------------------------------

### ProjectItem.renameBin()

Source: https://ppro-scripting.docsforadobe.dev/item/projectitem

Changes the name of a bin.

```APIDOC
## ProjectItem.renameBin(newName)

### Description
Changes name of bin. Only works on project items which are bins.

### Parameters
- **newName** (String) - Required - A new bin name.

### Returns
- **Integer** - Returns 0 if renaming bin was successful.
```

--------------------------------

### Project.setScratchDiskPath()

Source: https://ppro-scripting.docsforadobe.dev/general/project

Changes the specified scratch disk path to a new path.

```APIDOC
## Project.setScratchDiskPath(newPath, whichScratchDiskPath)

### Description
Changes the specified scratch disk path to a new path.

### Parameters
- **newPath** (String) - A new path.
- **whichScratchDiskPath** (ScratchDiskType enum) - One of: ScratchDiskType.FirstVideoCaptureFolder, ScratchDiskType.FirstAudioCaptureFolder, ScratchDiskType.FirstVideoPreviewFolder, ScratchDiskType.FirstAudioPreviewFolder, ScratchDiskType.FirstAutoSaveFolder, ScratchDiskType.FirstCCLibrariesFolder, ScratchDiskType.FirstCapsuleMediaFolder.

### Returns
- Returns 0 if unsuccessful.
```

--------------------------------

### Project.consolidateDuplicates()

Source: https://ppro-scripting.docsforadobe.dev/general/project

Invokes Premiere Pro's 'Consolidate Duplicate Footage' functionality.

```APIDOC
## Project.consolidateDuplicates()

### Description
Invokes Premiere Pro's "Consolidate Duplicate Footage" functionality, as available from the UI.

### Returns
Returns `0` if successful.
```

--------------------------------

### ProjectItem.getProjectColumnsMetadata()

Source: https://ppro-scripting.docsforadobe.dev/item/projectitem

Returns a JSON string containing all metadata from the current project view layout.

```APIDOC
## ProjectItem.getProjectColumnsMetadata()

### Description
Returns a JSON string to the user with all the metadata from the current project view layout.

### Returns
- **String** - A JSON string that can be parsed with JSON.parse(). Each object contains ColumnName, ColumnValue, ColumnID, and ColumnPath.
```

--------------------------------

### Project.exportFinalCutProXML()

Source: https://ppro-scripting.docsforadobe.dev/general/project

Exports an FCP XML representation of the entire project.

```APIDOC
## Project.exportFinalCutProXML(outputPath, suppressUI)

### Description
Exports an FCP XML representation of the entire project, to the specified output path.

### Parameters
- **outputPath** (String) - Required - An output path for .xml file.
- **suppressUI** (Integer) - Required - If 1, no warnings or alerts will be shown, during the export.

### Returns
Returns `0` if successful.
```

--------------------------------

### ProjectItem.deleteBin()

Source: https://ppro-scripting.docsforadobe.dev/item/projectitem

Deletes a bin and all its contents.

```APIDOC
## ProjectItem.deleteBin()

### Description
Deletes a bin and all its contents from the project.

### Returns
- **result** (Integer) - Returns 0 if deletion was successful.
```

--------------------------------

### Project.openSequence()

Source: https://ppro-scripting.docsforadobe.dev/general/project

Makes the Sequence object with the provided sequence ID active.

```APIDOC
## Project.openSequence(sequenceID)

### Description
Makes the Sequence object with the provided sequence ID, active. This will open the sequence in the Timeline panel.

### Parameters
- **sequenceID** (Sequence.sequenceID) - Required - A valid sequence ID that should be opened.

### Returns
- Returns true if successful, false if not.
```

--------------------------------

### Sequence.insertClip()

Source: https://ppro-scripting.docsforadobe.dev/sequence/sequence

Inserts a project item clip into the sequence at a specified time and track index.

```APIDOC
## Sequence.insertClip(projectItem, time, vTrackIndex, aTrackIndex)

### Description
Inserts a clip into the sequence on the specified video and audio tracks at the specified time.

### Parameters
- **projectItem** (ProjectItem object) - Required - The media to insert.
- **time** (Time) - Required - The time to add the item.
- **vTrackIndex** (Integer) - Required - Zero-based video track index.
- **aTrackIndex** (Integer) - Required - Zero-based audio track index.

### Returns
- **Boolean** - True if successful.
```

--------------------------------

### Project.importAEComps()

Source: https://ppro-scripting.docsforadobe.dev/print_page

Imports specified compositions from an After Effects .aep project file.

```APIDOC
## Project.importAEComps()

### Description
Imports specified Compositions (by name) from the containing After Effects .aep project file.

### Parameters
- **path** (String) - Required - A path to the After Effects .aep project file.
- **compNames** (Array of strings) - Required - Names of compositions within the specified project, to be imported.
- **targetBin** (ProjectItem object) - Optional - The destination bin for this import.

### Returns
- Returns 0 if successful.
```

--------------------------------

### Sequence.setOutPoint()

Source: https://ppro-scripting.docsforadobe.dev/sequence/sequence

Sets the sequence out point.

```APIDOC
## Sequence.setOutPoint(time)

### Description
Sets a new sequence out point.

### Parameters
- **time** (Integer or Time object) - Required - New time in seconds.

### Returns
- **Null**
```

--------------------------------

### Sequence.exportAsMediaDirect()

Source: https://ppro-scripting.docsforadobe.dev/sequence/sequence

Renders the sequence to the specified output path using a preset and work area type.

```APIDOC
## Sequence.exportAsMediaDirect(outputPath, presetPath, workAreaType)

### Description
Renders the sequence to the specified output path, using the specified output preset (.epr file), and honoring the specified work area type.

### Parameters
- **outputPath** (String) - Required - An output path, to which to render the media.
- **presetPath** (String) - Required - Path to the preset file (.epr file) which contains the encoding settings.
- **workAreaType** (Integer) - Required - The work area type to be rendered: 0 (entire sequence), 1 (in/out points), 2 (work area).

### Returns
- **Boolean** - true if successful.
```

--------------------------------

### Properties.doesPropertyExist()

Source: https://ppro-scripting.docsforadobe.dev/general/properties

Checks whether a given property exists in the application preferences.

```APIDOC
## Properties.doesPropertyExist(property)

### Description
Checks whether a given property exists in preferences.

### Parameters
- **property** (String) - Required - A property to check

### Returns
- Boolean
```

--------------------------------

### Project.saveAs()

Source: https://ppro-scripting.docsforadobe.dev/print_page

Saves the project to a new path.

```APIDOC
## Project.saveAs(path)

### Description
Exports the current project to a new unique file path, opens the project from the new location, and closes the previously-opened (and identical) project.

### Parameters
- **path** (String) - A path to a new file.

### Returns
- Returns 0 if successful, or an error code if not.
```

--------------------------------

### Project and Production Access

Source: https://ppro-scripting.docsforadobe.dev/application/application

Properties for accessing open projects, productions, and project management tools.

```APIDOC
## app.project
- **Type**: Project object
- **Description**: The currently active project.

## app.projects
- **Type**: ProjectCollection object (read-only)
- **Description**: An array referencing all open projects.

## app.production
- **Type**: Production object
- **Description**: The currently active production (returns null if none are open).

## app.projectManager
- **Type**: ProjectManager object
- **Description**: Provides access to project management functions.
```

--------------------------------

### app.isDocument()

Source: https://ppro-scripting.docsforadobe.dev/application/application

Determines whether the file at path can be opened as a Premiere Pro project.

```APIDOC
## app.isDocument(path)

### Description
Determines whether the file at path can be opened as a Premiere Pro project.

### Parameters
- **path** (String) - Required - A path to a file.

### Returns
- **Boolean** - Returns true if file can be opened as a Premiere Pro project.
```

--------------------------------

### ProjectItem.changeMediaPath()

Source: https://ppro-scripting.docsforadobe.dev/item/projectitem

Updates the project item to point to a new media path.

```APIDOC
## ProjectItem.changeMediaPath(newPath, overrideChecks)

### Description
Updates the project item to point to a new media path.

### Parameters
- **newPath** (String) - Required - A new path to the media file.
- **overrideChecks** (Boolean) - Required - Override any safety concerns.

### Returns
- **result** (Integer) - Returns 0 if replacement was successful.
```

--------------------------------

### ProjectItem.getOverrideColorSpaceList

Source: https://ppro-scripting.docsforadobe.dev/item/projectitem

Returns a list of available color spaces for the project item.

```APIDOC
## ProjectItem.getOverrideColorSpaceList

### Description
Returns an object containing a list of supported color spaces.

### Type
Javascript Object.
```

--------------------------------

### ProjectItem.getInPoint()

Source: https://ppro-scripting.docsforadobe.dev/item/projectitem

Obtains the current project item in point.

```APIDOC
## ProjectItem.getInPoint()

### Description
Obtains the current project item in point.

### Returns
- **Time** (Object)
```

--------------------------------

### Anywhere.isProductionOpen()

Source: https://ppro-scripting.docsforadobe.dev/general/anywhere

Checks if an Anywhere or Team Projects production is currently open.

```APIDOC
## Anywhere.isProductionOpen()

### Description
Retrieves whether an Anywhere or Team Projects production is currently open.

### Returns
Returns true if a production is open; false if not.
```

--------------------------------

### app.quit()

Source: https://ppro-scripting.docsforadobe.dev/application/application

Quits Premiere Pro.

```APIDOC
## app.quit()

### Description
Quits Premiere Pro; user will be prompted to save any changes to Project object.
```

--------------------------------

### Check property existence with doesPropertyExist

Source: https://ppro-scripting.docsforadobe.dev/general/properties

Verifies if specific preference keys exist within the application settings.

```javascript
var property = 'BE.Prefs.LabelNames.10';
var exists = app.properties.doesPropertyExist(property);
alert('Property "' + property + '" exists: ' + exists.toString());

property = 'BE.Prefs.LabelNames.99';
exists = app.properties.doesPropertyExist(property);
alert('Property "' + property + '" exists: ' + exists.toString());
```

--------------------------------

### Sequence.getExportFileExtension()

Source: https://ppro-scripting.docsforadobe.dev/sequence/sequence

Retrieves the file extension associated with the specified output preset.

```APIDOC
## Sequence.getExportFileExtension(outputPresetPath)

### Description
Retrieves the file extension associated with the specified output preset (.epr file).

### Parameters
- **outputPresetPath** (String) - Required - The output preset to be used.

### Returns
- **String** - The file extension.
```

--------------------------------

### ProjectItem.canProxy()

Source: https://ppro-scripting.docsforadobe.dev/item/projectitem

Checks if a proxy can be attached to the project item.

```APIDOC
## ProjectItem.canProxy()

### Description
Indicates whether it's possible to attach a proxy to this project item.

### Returns
- **result** (Boolean) - Returns true if the project item permits a proxy to be attached; false if not.
```

--------------------------------

### Project.pauseGrowing()

Source: https://ppro-scripting.docsforadobe.dev/general/project

Pauses or resumes growing file capture.

```APIDOC
## Project.pauseGrowing(pause)

### Description
Pauses (and resumes) growing file capture.

### Parameters
- **pause** (Integer) - Required - If 1, growing files are enabled.

### Returns
- Returns 0 if successful.
```

--------------------------------

### ProjectItem.setXMPMetadata()

Source: https://ppro-scripting.docsforadobe.dev/item/projectitem

Sets the XMP metadata associated with the project item.

```APIDOC
## ProjectItem.setXMPMetadata()

### Description
Sets the XMP metadata associated with the project item.

### Parameters
- **newXMP** (String) - Required - A new, serialized XMP metadata.

### Returns
- **0** (Integer) - Returned if update was successful.
```

--------------------------------

### Sequence.exportAsFinalCutProXML()

Source: https://ppro-scripting.docsforadobe.dev/sequence/sequence

Creates a new FCP XML representation of the sequence and its constituent media.

```APIDOC
## Sequence.exportAsFinalCutProXML(outputPath)

### Description
Creates a new FCP XML representation of the sequence and its constituent media.

### Parameters
- **outputPath** (String) - Required - The output path for the new FCP XML file.

### Returns
- **Boolean** - true if successful.
```

--------------------------------

### Project.importSequences()

Source: https://ppro-scripting.docsforadobe.dev/general/project

Imports an array of sequence objects from a specified project into the current project.

```APIDOC
## Project.importSequences(path, sequenceIDs)

### Description
Imports an array of sequence objects (with specified sequenceIDs), from the specified project, into the current project.

### Parameters
- **path** (String) - Required - A path to a project file.
- **sequenceIDs** (Array) - Required - An array of sequence IDs to import.

### Returns
- Returns 0 if successful.
```

--------------------------------

### Encoder.encodeFile()

Source: https://ppro-scripting.docsforadobe.dev/general/encoder

Renders a specified file using Adobe Media Encoder with defined settings.

```APIDOC
## Encoder.encodeFile(filePath, outputPath, presetPath, workArea, removeUponCompletion, inPoint, outPoint)

### Description
Makes Adobe Media Encoder render (optionally, a specified range from) the specified file, with the specified settings.

### Parameters
- **filePath** (String) - A path to a file to render.
- **outputPath** (String) - A path to an output file.
- **presetPath** (String) - A path to a preset (.epr) file.
- **workArea** (Integer) - Integer denoting work area: 0 (ENCODE_ENTIRE), 1 (ENCODE_IN_TO_OUT), 2 (ENCODE_WORK_AREA).
- **removeUponCompletion** (Integer) - If 1, job will be removed once complete.
- **inPoint** (Time object) - The in point of the new file.
- **outPoint** (Time object) - The out point of the new file.

### Returns
- **jobID** (String) - The job ID for the render job added to the AME queue, or 0 if unsuccessful.
```
Tokens:
Raw