Application object¶
app
Description¶
Provides access to objects and application settings within Premiere Pro.
The single global object is always available by its name, app
.
Attributes¶
app.anywhere¶
app.anywhere
Description¶
An Anywhere object, providing access to available Anywhere servers. Only available when running in Anywhere configuration (discontinued).
Type¶
app.build¶
app.build
Description¶
The number of the build of Premiere Pro being run.
Type¶
String; read-only.
Example¶
Get a build version of current application.
// in Adobe Premiere Pro version 14.3.1 (Build 45)...
parseInt(app.build); // 45
app.encoder¶
app.encoder
Description¶
Provides access to Adobe Media Encoder (on the same system).
Warning
app.encoder
is broken on Premiere Pro 14.3.1 - 15 on Mac only. Fixed in 22 and up. See this discussion.
Type¶
app.getAppPrefPath¶
app.getAppPrefPath
Description¶
The path containing the currently active "Adobe Premiere Pro Prefs" file.
Type¶
String; read-only.
Example¶
Get a path to a currently active preference file
app.getAppPrefPath;
// /Users/USERNAME/Documents/Adobe/Premiere Pro/14.0/Profile-USERNAME/
app.getAppSystemPrefPath¶
app.getAppSystemPrefPath
Description¶
Premiere Pro's active configuration files, not specific to a given user.
Type¶
String; read-only.
Example¶
Get a path to a currently active configuration folder
app.getAppSystemPrefPath;
// /Library/Application Support/Adobe/Adobe Premiere Pro 2020/
app.getPProPrefPath¶
app.getPProPrefPath
Description¶
The path containing the currently active "Adobe Premiere Pro Prefs" file.
Type¶
String; read-only.
Example¶
Get a path to a currently active preference file
app.getPProPrefPath;
// /Users/USERNAME/Documents/Adobe/Premiere Pro/14.0/Profile-USERNAME/
app.getPProSystemPrefPath¶
app.getPProSystemPrefPath
Description¶
Premiere Pro's active configuration files, not specific to a given user.
Type¶
String; read-only.
Example¶
Get a path to a currently active configuration folder
app.getPProSystemPrefPath;
// /Library/Application Support/Adobe/Adobe Premiere Pro 2020/
app.learnPanelContentDirPath¶
app.learnPanelContentDirPath
Description¶
Get the Learn panel's contents directory path.
Type¶
String; read-only.
Example¶
Get a path to a Learn panel's directory
app.learnPanelContentDirPath;
// /Users/Shared/Adobe/Premiere Pro 2020/Learn Panel/
app.learnPanelExampleProjectDirPath¶
app.learnPanelExampleProjectDirPath
Description¶
Get the Learn panel's example projects directory path.
Type¶
String; read-only.
Example¶
Get a path to a Learn panel's example projects' directory
app.learnPanelExampleProjectDirPath;
// /Users/Shared/Adobe/Premiere Pro/14.0/Tutorial/Going Home project/
app.metadata¶
app.metadata
Description¶
Get applications Metadata object.
Type¶
Metadata object, read-only.
app.path¶
app.path
Description¶
Get a path to applications executable file.
Type¶
String; read-only.
Example¶
Get a path to applications executable file.
app.path;
// /Applications/Adobe Premiere Pro 2020/Adobe Premiere Pro 2020.app/
app.production¶
app.production
Description¶
The currently active production.
Type¶
Production object if at least 1 production is open, null
otherwise.
app.project¶
app.project
Description¶
The currently active project.
Type¶
app.projectManager¶
app.projectManager
Description¶
Provides access to project management functions within Premiere Pro.
Type¶
app.projects¶
app.projects
Description¶
An array referencing all open projects; numProjects
contains size.
Type¶
ProjectCollection object, read-only.
app.properties¶
app.properties
Description¶
The properties object provides methods to access and modify preference values.
Type¶
Properties object, read-only;
app.sourceMonitor¶
app.sourceMonitor
Description¶
Provides access to SourceMonitor object.
Type¶
app.userGuid¶
app.userGuid
Description¶
A unique identifier for the currently logged-in Creative Cloud user.
Type¶
String; read-only.
app.version¶
app.version
Description¶
The version of Premiere Pro, providing the API.
Type¶
String; read-only.
Example¶
Get a version of a current application (Adobe Premiere Pro version 14.3.1 (Build 45))
app.version; // 14.3.1
Methods¶
app.enableQE()¶
app.enableQE()
Description¶
Enables Premiere Pro's QE DOM.
Parameters¶
None.
Returns¶
Returns true
if QE DOM was enabled.
app.getEnableProxies()¶
app.getEnableProxies()
Description¶
Determines whether proxy usage is currently enabled.
Parameters¶
None.
Returns¶
Returns 1
if proxies are enabled, 0
if they are not.
app.getWorkspaces()¶
app.getWorkspaces()
Description¶
Obtains an array of available workspaces as Strings.
Parameters¶
None.
Returns¶
Array of strings if successful, null
if unsuccessful.
Example¶
Get a list of available workspaces.
app.getWorkspaces();
/* [
"All Panels",
"Assembly",
"Audio",
"Color",
"Editing",
"Effects",
"Graphics",
"Learning",
"Libraries",
"Metalogging",
"Production"
]; */
app.isDocument()¶
app.isDocument(path)
Description¶
Determines whether the file at path can be opened as a Premiere Pro project.
Parameters¶
Parameter | Type | Description |
---|---|---|
path |
String | A path to a file. |
Returns¶
Returns true
if file can be opened as a Premiere Pro project.
Example¶
Test for valid project files
app.isDocument('~/Desktop/myProject.prproj'); // true
app.isDocument('~/Desktop/textFile.txt'); // false
app.isDocument('~/Desktop/footageFile.mov'); // false
app.isDocument('~/Desktop/imageFile.mov'); // false
app.isDocumentOpen()¶
app.isDocumentOpen()
Description¶
Determines whether there are any projects currently open.
Parameters¶
None.
Returns¶
Returns true
if at least 1 project is open; otherwise false
.
app.newProject()¶
app.newProject(path)
Description¶
Creates a new .prproj Project object, at the specified path.
Parameters¶
Parameter | Type | Description |
---|---|---|
path |
String | A full path to new project; a .prproj extension will not be added. |
Returns¶
Returns true
if successful.
app.openDocument()¶
app.openDocument(path, [suppressConversionDialog], [bypassLocateFileDialog], [bypassWarningDialog], [doNotAddToMRUList])
Description¶
Opens the file at the specified path, as a Premiere Pro Project object.
Parameters¶
Parameter | Type | Description |
---|---|---|
path |
String | 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¶
Returns true
if file was successfully opened.
app.openFCPXML()¶
app.openFCPXML(path, projPath)
Description¶
Opens an FCP XML file as a Premiere Pro Project object (specified in projPath).
Parameters¶
Parameter | Type | Description |
---|---|---|
path |
String | |
projPath |
String |
Returns¶
Returns true
if file was successfully opened as a Premiere Pro Project object.
app.quit()¶
app.quit()
Description¶
Quits Premiere Pro; user will be prompted to save any changes to Project object.
Parameters¶
None.
Returns¶
Nothing.
app.setEnableProxies()¶
app.setEnableProxies(enabled)
Description¶
Determines whether proxy usage is currently enabled.
Parameters¶
Parameter | Type | Description |
---|---|---|
enabled |
Integer | 1 turns proxies on, 0 turns them off. |
Returns¶
Returns 1
if proxy enablement was changed.
app.setExtensionPersistent()¶
app.setExtensionPersistent(extensionID, persistent)
Description¶
Whether extension with the given extensionID persists, within this session.
Parameters¶
Parameter | Type | Description |
---|---|---|
extensionID |
String | Which extension to modify. |
persistent |
Integer | Pass 1 to keep extension in memory, 0 to allow unloading. |
Returns¶
Returns true
if successful.
Example¶
var extensionID = 'com.adobe.PProPanel';
// 0 - while testing (to enable rapid reload);
// 1 - for "Never unload me, even when not visible."
var persistent = 0;
app.setExtensionPersistent(extensionID, persistent);
app.setScratchDiskPath()¶
app.setScratchDiskPath(path, scratchDiskType)
Description¶
Specifies the path to be used for one of Premiere Pro's scratch disk paths.
Parameters¶
Parameter |
Type |
Description |
---|---|---|
|
String |
The new path to be used. |
|
|
Enumerated value, must be one of the following:
|
Returns¶
Returns true
if successful.
Example¶
var scratchPath = Folder.selectDialog('Choose new scratch disk folder');
if (scratchPath && scratchPath.exists) {
app.setScratchDiskPath(scratchPath.fsName, ScratchDiskType.FirstAutoSaveFolder);
}
app.setSDKEventMessage()¶
app.setSDKEventMessage(message, decorator)
Description¶
Writes a string to Premiere Pro's Events panel.
Parameters¶
Parameter |
Type |
Description |
---|---|---|
|
String |
A message to display. |
|
String |
Decorator, one of:
|
Returns¶
Returns true
if successful.
app.setWorkspace()¶
app.setWorkspace(workspace)
Description¶
Set workspace as active. Use app.getWorkspaces() to get a list of all available workspaces.
Parameters¶
Parameter | Type | Description |
---|---|---|
workspace |
String | The name of the workspace. |
Returns¶
Boolean.
Example¶
Activate "Editing" workspace.
var workspace = 'Editing';
if (app.setWorkspace(workspace)) {
alert('Workspace changed to "' + workspace + '"');
} else {
alert('Could not set "' + workspace + '" workspace');
}
app.trace()¶
app.trace()
Description¶
Writes a string to Premiere Pro's debug console.
Parameters¶
None.
Returns¶
Returns true
if trace was added.
app.getProjectViewIDs()¶
app.getProjectViewIDs()
Description¶
Returns the view IDs of currently-open views, associated with any project.
Parameters¶
None.
Returns¶
An array of view IDs; can be null.
Example¶
var allViewIDs = app.getProjectViewIDs();
if (allViewIDs){
var firstOne = allViewIDs[0];
} else {
// No views open.
}
app.getProjectFromViewID()¶
app.getProjectFromViewID()
Description¶
Returns the Project associated with the provided View ID.
Parameters¶
A View ID, obtained from getProjectViewIDs
.
Returns¶
A Project object, for the project associated with the provided View ID. Can be null
.
Example¶
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.
}
app.getCurrentProjectViewSelection()¶
app.getCurrentProjectViewSelection()
Description¶
Returns an array of ProjectItems selected, in the current active project view.
Parameters¶
None.
Returns¶
An array of ProjectItems; can be null.
Example¶
var selectedItems = app.getCurrentProjectViewSelection();
if (selectedItems){
var firstOne = selectedItems[0];
} else {
// No projectItems selected.
}