### Get Premiere Pro Learn Panel Example Project Directory Path Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the file path to the directory containing the Learn panel's example projects. This is a read-only string property. ```JavaScript app.learnPanelExampleProjectDirPath; // Returns the path to the Learn panel example projects directory ``` -------------------------------- ### Get Premiere Pro Learn Panel Example Project Directory Path Source: https://ppro-scripting.docsforadobe.dev/application/application Retrieves the directory path for the Learn panel's example projects. This is a read-only string property. ```javascript app.learnPanelExampleProjectDirPath; ``` -------------------------------- ### Get Project Item Start Time Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the start time of a project item as a Time object. This method does not take any parameters. ```javascript app.project.rootItem.children[index].startTime() ``` -------------------------------- ### Get ProjectItem Input LUTID Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the Input LUTID for a project item. The example demonstrates how to get the LUTID and log it to the Events panel. ```JavaScript var lutID = app.project.rootItem.children[0].getInputLUTID(); app.setSDKEventMessage("Input LutID " + " = " + lutID, 'info'); ``` -------------------------------- ### Play Source Monitor Source: https://ppro-scripting.docsforadobe.dev/print_page Starts playback in the Source monitor at a specified playback speed. Returns 0 if playback begins successfully. ```javascript app.sourceMonitor.play(playbackSpeed) ``` -------------------------------- ### Set Project Item Start Time Source: https://ppro-scripting.docsforadobe.dev/print_page Assigns a new start time to a project item, specified in ticks. The method returns 0 if the operation is successful. ```javascript app.project.rootItem.children[index].setStartTime(time) ``` -------------------------------- ### Get Premiere Pro Workspaces Source: https://ppro-scripting.docsforadobe.dev/print_page Obtains an array of strings representing the available workspaces in Premiere Pro. This method takes no parameters. ```JavaScript app.getWorkspaces(); // Returns an array of workspace names ``` -------------------------------- ### Marker Start Time Source: https://ppro-scripting.docsforadobe.dev/print_page Represents the starting time of a marker. It is a Time object and can be read or written. ```JavaScript app.project.activeSequence.markers.getFirstMarker().start app.project.rootItem.children[index].getMarkers().getFirstMarker().start ``` -------------------------------- ### Get Premiere Pro System Preferences Path Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the file path to Premiere Pro's active configuration files, which are not specific to a user. This is a read-only string property. ```JavaScript app.getAppSystemPrefPath; // Returns the path to the system configuration folder ``` -------------------------------- ### Get Premiere Pro PPro System Preferences Path Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the file path to Premiere Pro's active configuration files, which are not specific to a user. This is a read-only string property. ```JavaScript app.getPProSystemPrefPath; // Returns the path to the system configuration folder ``` -------------------------------- ### Get Project Item Video Components Source: https://ppro-scripting.docsforadobe.dev/print_page Returns the video components for the 'Master Clip' of a project item. The result is a read-only ComponentCollection object. ```javascript app.project.rootItem.children[index].videoComponents() ``` -------------------------------- ### Get ProjectItem Proxy Path Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the file path for the proxy associated with a project item. ```JavaScript var proxyPath = app.project.rootItem.children[index].getProxyPath(); ``` -------------------------------- ### Get Insertion Bin Source: https://ppro-scripting.docsforadobe.dev/print_page Returns a ProjectItem object that represents the bin where new imported items will be placed. This is useful for organizing imports programmatically. ```javascript app.project.getInsertionBin(); ``` -------------------------------- ### Start Batch Rendering in Adobe Media Encoder Source: https://ppro-scripting.docsforadobe.dev/print_page Initiates a batch rendering process in Adobe Media Encoder. This function is part of the 'Encoder' object. ```JavaScript app.encoder.startBatch() ``` -------------------------------- ### Get Premiere Pro Learn Panel Content Directory Path Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the file path to the directory containing the Learn panel's contents. This is a read-only string property. ```JavaScript app.learnPanelContentDirPath; // Returns the path to the Learn panel content directory ``` -------------------------------- ### Get Audio Channel Mapping Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the audio channel mapping applied to a specific project item. Returns an audioChannelMapping object. ```javascript app.project.rootItem.children[index].getAudioChannelMapping ``` -------------------------------- ### Get Premiere Pro Version Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the version of Adobe Premiere Pro that provides the API. This is a read-only string property. ```JavaScript app.version; // Returns the application version string ``` -------------------------------- ### Get Premiere Pro Workspaces Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves a list of all available workspaces in Premiere Pro. Returns an array of strings representing workspace names or null if an error occurs. ```JavaScript app.getWorkspaces(); /* [ "All Panels", "Assembly", "Audio", "Color", "Editing", "Effects", "Graphics", "Learning", "Libraries", "Metalogging", "Production" ]; */ ``` -------------------------------- ### Get Project Item from Source Monitor Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the project item currently open in the Source monitor. Returns the projectItem object if successful, otherwise returns null. ```javascript app.sourceMonitor.getProjectItem() ``` -------------------------------- ### Get TrackItem Start Time Source: https://ppro-scripting.docsforadobe.dev/print_page Gets or sets the visible start time of a track item within its sequence. This property is read/write. ```javascript app.project.sequences[index].audioTracks[index].clips[index].start; app.project.sequences[index].videoTracks[index].clips[index].start; ``` -------------------------------- ### PProPanel Sample for Premiere Pro ExtendScript API Source: https://ppro-scripting.docsforadobe.dev/introduction/extendscript-overview The PProPanel sample demonstrates how to use Premiere Pro's ExtendScript API to access and manipulate project elements. It serves as a practical example for developers. ```ExtendScript https://github.com/Adobe-CEP/Samples/tree/master/PProPanel ``` -------------------------------- ### Get Project Panel Layout Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the current layout configuration of the Project panel as a string. This can be used to save and restore panel arrangements. ```javascript app.project.getProjectPanelMetadata(); ``` -------------------------------- ### Open FCP XML as Premiere Pro Project Source: https://ppro-scripting.docsforadobe.dev/print_page Opens an FCP XML file and converts it into a Premiere Pro Project object. Requires the path to the FCP XML file and the desired output project path. Returns true on success. ```JavaScript app.openFCPXML(path, projPath); ``` -------------------------------- ### Get Sequence In Point (Seconds) Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the current in point of the sequence, expressed in seconds. This value indicates the starting frame for playback or editing operations within the sequence. ```JavaScript app.project.sequences[index].getInPoint() ``` -------------------------------- ### Import MOGRT from File Source: https://ppro-scripting.docsforadobe.dev/print_page Imports a Motion Graphics Template (MOGRT) from a specified file path into the sequence. It allows specifying the insertion time and target video/audio tracks. ```javascript app.project.sequences[index].importMGT(path, time, vidTrackOffset, audTrackOffset) ``` -------------------------------- ### Component.matchName - Get Match Name Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the match name of a component, used for uniquely identifying effect plug-ins on disk. This is read-only. ```JavaScript app.project.sequences[index].audioTracks[index].clips[index].components[index].matchName app.project.sequences[index].videoTracks[index].clips[index].components[index].matchName ``` -------------------------------- ### Get Project Item Type Source: https://ppro-scripting.docsforadobe.dev/print_page Returns the type of a project item, which can be CLIP, BIN, ROOT, or FILE. This is a read-only enumerated value. ```javascript app.project.rootItem.children[index].type ``` -------------------------------- ### Add Project to Production Source: https://ppro-scripting.docsforadobe.dev/print_page Copies a project from a source path into the Production directory. Returns true if successful. ```ExtendScript app.production.addProject(srcProjectPath, destProjectPath); ``` -------------------------------- ### Get TrackItem Name Source: https://ppro-scripting.docsforadobe.dev/print_page Gets or sets the name of a track item. This property is read/write. ```javascript app.project.sequences[index].audioTracks[index].clips[index].name; app.project.sequences[index].videoTracks[index].clips[index].name; ``` -------------------------------- ### Add Project to Production - ExtendScript Source: https://ppro-scripting.docsforadobe.dev/general/production Use the addProject method to copy a project from a source path into the production directory. It requires source and destination paths and returns true on success. ```ExtendScript app.production.addProject(srcProjectPath, destProjectPath) ``` -------------------------------- ### Get Sequence Settings Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the current settings of the active sequence. This includes parameters like frame rate, resolution, and audio settings, which define the sequence's playback and rendering characteristics. ```JavaScript app.project.sequences[index].getSettings() ``` -------------------------------- ### Accessing Anywhere Servers Source: https://ppro-scripting.docsforadobe.dev/print_page The 'app.anywhere' attribute provides access to available Anywhere servers. This functionality is specifically available when running in an Anywhere configuration, which is now discontinued. ```ExtendScript app.anywhere ``` -------------------------------- ### ProjectItem: Get Start Time Source: https://ppro-scripting.docsforadobe.dev/item/projectitem Retrieves the start time of a project item as a Time object. This method does not take any parameters. ```javascript app.project.rootItem.children[index].startTime(); ``` -------------------------------- ### Get Premiere Pro Application Path Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the file path to the executable of the Adobe Premiere Pro application. This is a read-only string property. ```JavaScript app.path; // Returns the path to the application executable ``` -------------------------------- ### Create Smart Bin within ProjectItem Source: https://ppro-scripting.docsforadobe.dev/item/projectitem Creates a smart bin (search bin) within a ProjectItem, based on a provided query string. This is applicable only to bin ProjectItems. ```Javascript app.project.rootItem.children[index].createSmartBin(name, queryString); ``` -------------------------------- ### Get TrackItem Out Point Source: https://ppro-scripting.docsforadobe.dev/print_page Gets or sets the out point of a track item, relative to the source media's beginning. This property is read/write. ```javascript app.project.sequences[index].audioTracks[index].clips[index].outPoint; app.project.sequences[index].videoTracks[index].clips[index].outPoint; ``` -------------------------------- ### Get Proxy Media Path - ProjectItem Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the file system path to the proxy media associated with a project item. Returns '0' if no proxy media is found. ```javascript app.project.rootItem.children[index].getProxyMediaFile(); ``` -------------------------------- ### Create New Premiere Pro Project Source: https://ppro-scripting.docsforadobe.dev/application/application Creates a new Premiere Pro project file at the specified path. Returns true if the creation was successful. ```JavaScript app.newProject(path); ``` -------------------------------- ### Debugging ExtendScript with VSCode Source: https://ppro-scripting.docsforadobe.dev/print_page The recommended environment for debugging ExtendScript in Premiere Pro is Microsoft Visual Studio Code, utilizing Adobe's ExtendScript debugging extension. This setup facilitates efficient script development and troubleshooting. ```VSCode https://marketplace.visualstudio.com/items?itemName=Adobe.extendscript-debug ``` -------------------------------- ### ExtendScript Debugging with Visual Studio Code Source: https://ppro-scripting.docsforadobe.dev/introduction/extendscript-overview This snippet provides information on setting up Visual Studio Code with the Adobe ExtendScript debugging extension for developing and debugging ExtendScript code. ```VSCode Extension https://marketplace.visualstudio.com/items?itemName=Adobe.extendscript-debug ``` -------------------------------- ### Get Sequence Timebase Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the timebase of the sequence. ```JavaScript app.project.sequences[index].timebase ``` -------------------------------- ### Save Project Source: https://ppro-scripting.docsforadobe.dev/print_page Saves the current project at its existing file path. ```javascript app.project.save() ``` -------------------------------- ### Get Time in Ticks Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the time value expressed in ticks. ```JavaScript myTime.ticks ``` -------------------------------- ### Import MOGRT from Creative Cloud Library Source: https://ppro-scripting.docsforadobe.dev/print_page Imports a MOGRT from the user's Creative Cloud Libraries into the sequence. This method requires the library name, MOGRT name, insertion time, and target tracks. ```javascript app.project.sequences[index].importMGTFromLibrary(libraryName, mgtName, time, vidTrackOffset, audTrackOffset) ``` -------------------------------- ### Enable Premiere Pro QE DOM Source: https://ppro-scripting.docsforadobe.dev/application/application Enables Premiere Pro's QE DOM (Dynamic Object Model). This method takes no parameters. ```javascript app.enableQE(); ``` -------------------------------- ### Get Time in Seconds Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the time value expressed in seconds. ```JavaScript myTime.seconds ``` -------------------------------- ### Get Premiere Pro Preferences Path Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the file path to the currently active 'Adobe Premiere Pro Prefs' file. This is a read-only string property. ```JavaScript app.getAppPrefPath; // Returns the path to the active preferences file ``` -------------------------------- ### Create New Premiere Pro Project Source: https://ppro-scripting.docsforadobe.dev/print_page Creates a new Premiere Pro project file at the specified path. The function takes a file path string as an argument and returns true if successful. ```JavaScript app.newProject(path); ``` -------------------------------- ### Get Property Value in Premiere Pro Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the value of a specified property from Premiere Pro's preferences. It includes a check to ensure the property exists before attempting to get its value. ```JavaScript var labelIndex = 0; var property = 'BE.Prefs.LabelNames.' + labelIndex; if (app.properties.doesPropertyExist(property)) { alert(app.properties.getProperty(property)); } else { alert('Property "' + property + '" does not exist'); } ``` -------------------------------- ### Get Premiere Pro Build Version Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the build number of the currently running Adobe Premiere Pro application. This is a read-only string property. ```JavaScript parseInt(app.build); // Returns the build number as an integer ``` -------------------------------- ### Import After Effects Compositions Source: https://ppro-scripting.docsforadobe.dev/print_page Imports specified Compositions by name from an After Effects .aep project file into the current project. Optionally, a target bin can be specified for the imported compositions. ```javascript app.project.importAllAEComps(path, [targetBin]) ``` -------------------------------- ### Get Premiere Pro PPro Preferences Path Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the file path to the currently active 'Adobe Premiere Pro Prefs' file. This is a read-only string property. ```JavaScript app.getPProPrefPath; // Returns the path to the active preferences file ``` -------------------------------- ### Import After Effects Compositions Source: https://ppro-scripting.docsforadobe.dev/print_page Imports specified compositions from an After Effects project file (.aep) into the current Premiere Pro project. Users can optionally specify a target bin for the imported compositions. ```javascript app.project.importAEComps(path, compNames, [targetBin]); ``` -------------------------------- ### Component.displayName - Get Display Name Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the user-facing display name of a component. This name is localized. ```JavaScript app.project.sequences[index].audioTracks[index].clips[index].components[index].displayName app.project.sequences[index].videoTracks[index].clips[index].components[index].displayName ``` -------------------------------- ### Attach Proxy to Project Item Source: https://ppro-scripting.docsforadobe.dev/print_page Attaches proxy or high-resolution media to a project item. Requires the media path and an integer indicating whether it's a proxy (0) or high-res (1) media. Returns 0 on success. ```javascript app.project.rootItem.children[index].attachProxy(mediaPath, isHiRes) ``` -------------------------------- ### Sequence: Set Zero Point Source: https://ppro-scripting.docsforadobe.dev/print_page Sets the starting time (zero point) of a sequence. It requires a string representing the new zero point in ticks and returns a boolean indicating success. ```JavaScript app.project.sequences[index].setZeroPoint(newZeroPoint) ``` -------------------------------- ### Get ProjectItem Markers Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the MarkerCollection object associated with a project item. This collection is read-only. ```JavaScript var markers = app.project.rootItem.children[index].getMarkers(); ``` -------------------------------- ### Get Number of Items in ComponentCollection Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the total number of items within a ComponentCollection. This attribute is read-only. ```JavaScript app.project.rootItem.children[index].videoComponents().numItems ``` ```JavaScript app.project.sequences[index].audioTracks[index].clips[index].components.numItems ``` ```JavaScript app.project.sequences[index].videoTracks[index].clips[index].components.numItems ``` -------------------------------- ### Get Number of Audio Clips Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the number of audio clips associated with a specific audio channel. ```JavaScript app.project.rootItem.children[index].getAudioChannelMapping.audioClipsNumber ``` -------------------------------- ### Premiere Pro Scripting API Overview Source: https://ppro-scripting.docsforadobe.dev/print_page Premiere Pro offers an ExtendScript API for accessing and manipulating project elements, including metadata, exporting, and rendering options. This API has evolved significantly, providing comprehensive control over project elements and application settings. ```ExtendScript app.getCurrentProjectViewSelection() TrackItem.move() TrackItem.disabled Sequence.autoReframeSequence() Marker.getColorByIndex() Marker.setColorByIndex() ``` -------------------------------- ### Accessing Premiere Pro Application Object Source: https://ppro-scripting.docsforadobe.dev/print_page The global 'app' object in Premiere Pro provides access to application settings and various objects within the application. It is the primary interface for interacting with Premiere Pro through ExtendScript. ```ExtendScript app ``` -------------------------------- ### Get Sequence End Time Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the end time of the sequence in ticks. This is a read-only string property. ```JavaScript app.project.sequences[index].end ``` -------------------------------- ### TrackItem.disabled - Set Disabled State Source: https://ppro-scripting.docsforadobe.dev/print_page Sets or gets the disabled state of a TrackItem. A TrackItem can be enabled or disabled. ```JavaScript app.project.sequences[index].audioTracks[index].clips[index].disabled app.project.sequences[index].videoTracks[index].clips[index].disabled ``` -------------------------------- ### Access Production Object - ExtendScript Source: https://ppro-scripting.docsforadobe.dev/general/production Access the Production object to manage productions and projects within ExtendScript. This is the primary entry point for production-related operations. ```ExtendScript app.production ``` -------------------------------- ### ProjectItem.createSmartBin() - JavaScript Source: https://ppro-scripting.docsforadobe.dev/print_page Creates a search bin, which functions as a smart folder, within a project item. This operation is only supported for bin project items. It requires the name for the new bin and a query string for the search criteria. It returns the newly created bin as a project item upon success. ```JavaScript app.project.rootItem.children[index].createSmartBin(name, queryString) ``` -------------------------------- ### Get TrackItem Node ID Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the unique node identifier for a track item. This property is read-only. ```javascript app.project.sequences[index].audioTracks[index].clips[index].nodeId; app.project.sequences[index].videoTracks[index].clips[index].nodeId; ``` -------------------------------- ### TrackItem.getMatchName() - Get Match Name Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the match name for a TrackItem. This method can be called on both audio and video tracks. ```JavaScript app.project.sequences[index].audioTracks[index].clips[index].getMatchName() app.project.sequences[index].videoTracks[index].clips[index].getMatchName() ``` -------------------------------- ### Create New Bars and Tone Sequence Source: https://ppro-scripting.docsforadobe.dev/general/project Creates a new Sequence object for bars and tone with specified properties such as dimensions, time base, pixel aspect ratio, audio sample rate, and name. ```javascript app.project.newBarsAndTone(width, height, timeBase, PARNum, PARDen, audioSampleRate, name) ``` -------------------------------- ### Get TrackItem Media Type Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the media type (Audio or Video) of a track item. This property is read-only. ```javascript app.project.sequences[index].audioTracks[index].clips[index].mediaType; app.project.sequences[index].videoTracks[index].clips[index].mediaType; ``` -------------------------------- ### Get ProjectItem Media Path Source: https://ppro-scripting.docsforadobe.dev/print_page Returns the file path associated with a project item's media as a String. This method is applicable to atomic media and returns the path to the first image for image sequences. ```JavaScript var mediaPath = app.project.rootItem.children[index].getMediaPath(); ``` -------------------------------- ### app.anywhere.getAuthenticationToken() - Get Anywhere Authentication Token Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves an authentication token for accessing Adobe Anywhere or Team Projects servers. It takes no parameters and returns the token as a string, or '0' if the operation fails. ```JavaScript app.anywhere.getAuthenticationToken() ``` -------------------------------- ### Save Project As New Location Source: https://ppro-scripting.docsforadobe.dev/print_page Exports the current project to a new file path, opens the project from the new location, and closes the original project. ```javascript app.project.saveAs(path) ``` -------------------------------- ### Marker Name Source: https://ppro-scripting.docsforadobe.dev/print_page Allows getting or setting the name of a marker. This provides a way to label markers for easier identification. ```JavaScript app.project.activeSequence.markers.getFirstMarker().name app.project.rootItem.children[index].getMarkers().getFirstMarker().name ``` -------------------------------- ### ComponentParam.displayName - Get Parameter Display Name Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the user-facing display name of a component parameter. This name is localized and read-only. ```JavaScript app.project.sequences[index].audioTracks[index].clips[index].components[index].properties[index].displayName app.project.sequences[index].videoTracks[index].clips[index].components[index].properties[index].displayName ``` -------------------------------- ### Import Sequences from Project Source: https://ppro-scripting.docsforadobe.dev/print_page Imports an array of sequence objects, identified by their sequence IDs, from a specified project file into the current project. ```javascript app.project.importSequences(path, sequenceIDs) ``` -------------------------------- ### Create Sub-Clip - JavaScript Source: https://ppro-scripting.docsforadobe.dev/item/projectitem Creates a new project item representing a sub-clip of an existing project item. Requires the name, start time, end time, and flags for video and audio inclusion. ```javascript app.project.rootItem.children[index].createSubClip(name, startTime, endTime, hasHardBoundaries, takeAudio, takeVideo) ``` -------------------------------- ### Get TrackItem Speed Source: https://ppro-scripting.docsforadobe.dev/print_page Returns the speed multiplier applied to a track item. A value of 1 indicates normal speed. ```javascript app.project.sequences[index].audioTracks[index].clips[index].getSpeed(); app.project.sequences[index].videoTracks[index].clips[index].getSpeed(); ``` -------------------------------- ### ProjectItem: Set Start Time Source: https://ppro-scripting.docsforadobe.dev/item/projectitem Assigns a new start time to a project item, represented in ticks as a string. Returns 0 if the operation is successful. ```javascript app.project.rootItem.children[index].setStartTime(time); ``` -------------------------------- ### Get Color Space Properties - JavaScript Source: https://ppro-scripting.docsforadobe.dev/item/projectitem Retrieves the color space properties of a project item, including its name, transfer characteristic, primaries, and matrix equation. The example demonstrates logging these properties to the Events panel. ```javascript var colorSpace = app.project.rootItem.children[0].getColorSpace() app.setSDKEventMessage("Color Space " + " = " + colorSpace.name, 'info'); app.setSDKEventMessage("Transfer Characteristic " + " = " + colorSpace.transferCharacteristic, 'info'); app.setSDKEventMessage("Color Primaries " + " = " + colorSpace.primaries, 'info'); app.setSDKEventMessage("Matrix Equation " + " = " + colorSpace.matrixEquation, 'info'); ``` -------------------------------- ### Get ProjectItem In Point Source: https://ppro-scripting.docsforadobe.dev/print_page Obtains the current in-point for a project item. The method returns a Time object representing the in-point. ```JavaScript var inPoint = app.project.rootItem.children[index].getInPoint(); ``` -------------------------------- ### Get Team Projects Asset ID Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the Team Projects Asset ID for a project item. This property is read-only. ```javascript app.project.rootItem.children[index].teamProjectsAssetId ``` -------------------------------- ### Import MOGRT from File Source: https://ppro-scripting.docsforadobe.dev/sequence/sequence Imports a Motion Graphics Template (MOGRT) from a specified file path into the sequence. It allows specifying the insertion time and target video/audio tracks. ```javascript app.project.sequences[index].importMGT(path, time, vidTrackOffset, audTrackOffset) ``` -------------------------------- ### Import Files into Project Source: https://ppro-scripting.docsforadobe.dev/print_page Imports media files from specified paths into the current project. This method allows suppressing UI dialogs and specifying a target bin for the imported files. It can also handle importing file paths as numbered stills. ```javascript app.project.importFiles(filePaths, suppressUI, targetBin, importAsNumberedStills) ``` -------------------------------- ### Get Project Item Children Source: https://ppro-scripting.docsforadobe.dev/print_page Accesses the children of a project item, which are themselves project items. This is read-only and returns a ProjectItemCollection object. ```javascript app.project.rootItem.children[index].children ``` -------------------------------- ### Move Item to Production Trash Source: https://ppro-scripting.docsforadobe.dev/print_page Moves a specified path (bin) or .prproj file into the Production's Trash folder. Returns true if successful. ```ExtendScript app.production.moveToTrash(projectOrFolderPath, suppressUI, saveProject); ``` -------------------------------- ### Get Web Link URL Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the URL from a marker's URL field. Returns a string or 0 if unsuccessful. ```JavaScript app.project.activeSequence.markers.getFirstMarker().getWebLinkURL() app.project.rootItem.children[index].getMarkers().getFirstMarker().getWebLinkURL() ``` -------------------------------- ### app.anywhere.listProductions() - List Available Productions Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves a list of production names available to the current user on the connected Adobe Anywhere or Team Projects server. It returns an array of strings containing production names, or '0' if unsuccessful. ```JavaScript app.anywhere.listProductions() ``` -------------------------------- ### Get Marker Color Index Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the color index of a marker. This functionality was introduced in Adobe Premiere Pro 13.x. ```JavaScript app.project.activeSequence.markers.getFirstMarker().getColorByIndex(index) app.project.rootItem.children[index].getMarkers().getFirstMarker().getColorByIndex(index) ``` -------------------------------- ### Get ProjectItem Footage Interpretation Source: https://ppro-scripting.docsforadobe.dev/print_page Returns a structure detailing the current interpretation of a project item's footage. This includes alpha channel usage, field type, frame rate, pixel aspect ratio, pulldown removal, and VR-specific settings. ```JavaScript var interpretation = app.project.rootItem.children[index].getFootageInterpretation(); ``` -------------------------------- ### Open File in Source Monitor Source: https://ppro-scripting.docsforadobe.dev/print_page Opens a specified file in the Source monitor. Requires a string representing the file path. Returns true upon successful opening. ```javascript app.sourceMonitor.openFilePath(path) ``` -------------------------------- ### Set Premiere Pro Scratch Disk Path Source: https://ppro-scripting.docsforadobe.dev/application/application Allows users to select a folder to be used as the Premiere Pro scratch disk. It then sets the chosen folder as the first auto-save location. ```JavaScript var scratchPath = Folder.selectDialog('Choose new scratch disk folder'); if (scratchPath && scratchPath.exists) { app.setScratchDiskPath(scratchPath.fsName, ScratchDiskType.FirstAutoSaveFolder); } ``` -------------------------------- ### Get Sequence Unique ID Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the unique identifier assigned to the sequence at creation, in UUID format. This is a read-only string property. ```JavaScript app.project.sequences[index].sequenceID ``` -------------------------------- ### Open FCP XML File in Premiere Pro Source: https://ppro-scripting.docsforadobe.dev/application/application Opens an FCP XML file and imports it as a Premiere Pro Project object at the specified project path. Returns true if the import was successful. ```JavaScript app.openFCPXML(path, projPath); ``` -------------------------------- ### Start Adobe Media Encoder Batch Rendering Source: https://ppro-scripting.docsforadobe.dev/general/encoder Initiates the rendering process for all jobs currently in the Adobe Media Encoder render queue. Returns 0 if successful. ```JavaScript app.encoder.startBatch(); ``` -------------------------------- ### Get TrackItem Project Item Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the ProjectItem object associated with the track item's media source. This property is read-only. ```javascript app.project.sequences[index].audioTracks[index].clips[index].projectItem; app.project.sequences[index].videoTracks[index].clips[index].projectItem; ``` -------------------------------- ### Close Production Source: https://ppro-scripting.docsforadobe.dev/print_page Closes the Production and all open projects within it. Returns true if successful. ```ExtendScript app.production.close(); ``` -------------------------------- ### Get XMP Metadata - ProjectItem Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the XMP metadata associated with a project item as a serialized string. This method does not take any parameters. ```javascript app.project.rootItem.children[index].getXMPMetadata(); ``` -------------------------------- ### Create New Sequence Source: https://ppro-scripting.docsforadobe.dev/general/project Creates a new Sequence object with a given name, based on a specified preset file (.sqpreset). ```javascript app.project.newSequence(name, pathToSequencePreset) ``` -------------------------------- ### Create New Bars and Tone Sequence Source: https://ppro-scripting.docsforadobe.dev/print_page Creates a new Sequence object for bars and tone with specified properties such as dimensions, time base, pixel aspect ratio, audio sample rate, and name. ```javascript app.project.newBarsAndTone(width, height, timeBase, PARNum, PARDen, audioSampleRate, name) ``` -------------------------------- ### Get First Marker Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the first marker associated with an active sequence or a project item. This is useful for accessing marker data. ```JavaScript app.project.activeSequence.markers.getFirstMarker() app.project.rootItem.children[index].getMarkers().getFirstMarker() ``` -------------------------------- ### ProjectItem.createBin() - JavaScript Source: https://ppro-scripting.docsforadobe.dev/print_page Creates an empty bin within a specified project item. This method is only effective when used within existing bins. It requires a string parameter for the new bin's name and returns a project item representing the new bin on success, or 0 if it fails. ```JavaScript app.project.rootItem.children[index].createBin(name) ``` -------------------------------- ### Rename Project Item Source: https://ppro-scripting.docsforadobe.dev/print_page Modifies the name of a project item. This is a read/write operation. The example shows how to append text to the existing name. ```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 Audio Channel Type Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the type of audio contained in a channel. The type can be Mono (0), Stereo (1), or 5.1 (2). ```JavaScript app.project.rootItem.children[index].getAudioChannelMapping.audioChannelsType ``` -------------------------------- ### Set Premiere Pro Scratch Disk Path Source: https://ppro-scripting.docsforadobe.dev/application/application Specifies the path for one of Premiere Pro's scratch disk locations. Returns true if the path was set successfully. ```JavaScript app.setScratchDiskPath(path, scratchDiskType); ``` -------------------------------- ### Get Sequence ID Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the ordinal ID assigned to the sequence upon creation. Note: This attribute may be unstable; Sequence.sequenceID is recommended. ```JavaScript app.project.sequences[index].id ``` -------------------------------- ### Import After Effects Compositions Source: https://ppro-scripting.docsforadobe.dev/general/project Imports specified Compositions by name from an After Effects .aep project file into the current project. Optionally, a target bin can be specified for the imported compositions. ```javascript app.project.importAllAEComps(path, [targetBin]) ``` -------------------------------- ### Get TrackItem Type Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the type of media for a track item, where 1 indicates video and 2 indicates audio. This property is read-only. ```javascript app.project.sequences[index].audioTracks[index].clips[index].type; app.project.sequences[index].videoTracks[index].clips[index].type; ``` -------------------------------- ### Launch Adobe Media Encoder Source: https://ppro-scripting.docsforadobe.dev/print_page Launches the Adobe Media Encoder application. This function is part of the 'Encoder' object. ```JavaScript app.encoder.launchEncoder() ``` -------------------------------- ### Get Shared Location Path Source: https://ppro-scripting.docsforadobe.dev/print_page Returns the file path to the directory where shared project files are stored. This is often used in collaborative environments. ```javascript app.project.getSharedLocation(); ``` -------------------------------- ### Open Project Item in Source Monitor Source: https://ppro-scripting.docsforadobe.dev/print_page Opens a given ProjectItem object in the Source monitor. Returns 0 if the operation is successful. ```javascript app.sourceMonitor.openProjectItem(projectItem) ``` -------------------------------- ### Create Bin within ProjectItem Source: https://ppro-scripting.docsforadobe.dev/item/projectitem Creates a new, empty bin inside a specified ProjectItem. This operation is only valid for existing bins. ```Javascript app.project.rootItem.children[index].createBin(name); ``` -------------------------------- ### Open Premiere Pro Document Source: https://ppro-scripting.docsforadobe.dev/print_page Opens a Premiere Pro project file from the specified path. It accepts the file path and several optional boolean parameters to control dialog behavior. Returns true if the file was opened successfully. ```JavaScript app.openDocument(path, [suppressConversionDialog], [bypassLocateFileDialog], [bypassWarningDialog], [doNotAddToMRUList]); ``` -------------------------------- ### Get Graphics White Luminance Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the current graphics white luminance value configured for the project. This setting is relevant for HDR workflows. ```javascript app.project.getGraphicsWhiteLuminance(); ``` -------------------------------- ### Get Project Path - JavaScript Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the file path of the currently active project in Adobe Premiere Pro. This is a read-only string property. ```JavaScript app.project.path; // /Users/USERNAME/Desktop/Project.prproj ``` -------------------------------- ### Import After Effects Compositions Source: https://ppro-scripting.docsforadobe.dev/general/project Imports specified compositions from an After Effects project file (.aep) into the current Premiere Pro project. Users can optionally specify a target bin for the imported compositions. ```javascript app.project.importAEComps(path, compNames, [targetBin]); ``` -------------------------------- ### Select Project Item - ProjectItem Source: https://ppro-scripting.docsforadobe.dev/print_page Sets the project item as the target for subsequent import operations. This method is intended for use with bins. ```javascript app.project.rootItem.children[index].select(); ``` -------------------------------- ### Get Web Link Frame Target Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the frame target from a marker's FrameTarget field. Returns a string or 0 if unsuccessful. ```JavaScript app.project.activeSequence.markers.getFirstMarker().getWebLinkFrameTarget() app.project.rootItem.children[index].getMarkers().getFirstMarker().getWebLinkFrameTarget() ``` -------------------------------- ### Launch Adobe Media Encoder Source: https://ppro-scripting.docsforadobe.dev/general/encoder Launches the Adobe Media Encoder application. Returns 0 if the launch is successful. ```JavaScript app.encoder.launchEncoder(); ``` -------------------------------- ### Get Sequence Unique ID Source: https://ppro-scripting.docsforadobe.dev/sequence/sequence Retrieves the unique identifier (GUID) assigned to a Premiere Pro sequence at creation. This attribute is read-only. ```javascript app.project.sequences[index].sequenceID; ``` -------------------------------- ### Get Input LUT ID - JavaScript Source: https://ppro-scripting.docsforadobe.dev/item/projectitem Retrieves the input LUT ID of a project item. The example demonstrates logging this ID to the Events panel. ```javascript var lutID = app.project.rootItem.children[0].getInputLUTID() app.setSDKEventMessage("Input LutID " + " = " + inputLutID, 'info'); ``` -------------------------------- ### Get Premiere Pro Learn Panel Content Directory Path Source: https://ppro-scripting.docsforadobe.dev/application/application Retrieves the directory path for the Learn panel's contents. This is a read-only string property. ```javascript app.learnPanelContentDirPath; ``` -------------------------------- ### Get Embedded LUT ID - JavaScript Source: https://ppro-scripting.docsforadobe.dev/item/projectitem Retrieves the embedded LUT ID of a project item. The example shows how to log this ID to the Events panel. ```javascript var lutID = app.project.rootItem.children[0].getEmbeddedLUTID() app.setSDKEventMessage("LutID " + " = " + lutID, 'info'); ``` -------------------------------- ### Get Premiere Pro System Preference Path (PPro) Source: https://ppro-scripting.docsforadobe.dev/application/application Retrieves the file path for Premiere Pro's active configuration files, which are not user-specific. This is a read-only string property. ```javascript app.getPProSystemPrefPath; ``` -------------------------------- ### Get Sequence Work Area Out Point (Seconds) Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the current sequence work area out point, expressed in seconds. The returned value is a string. ```javascript app.project.sequences[index].getWorkAreaOutPoint() ``` -------------------------------- ### Get Premiere Pro System Preference Path Source: https://ppro-scripting.docsforadobe.dev/application/application Retrieves the file path for Premiere Pro's active configuration files, which are not user-specific. This is a read-only string property. ```javascript app.getAppSystemPrefPath; ``` -------------------------------- ### Get Sequence Vertical Frame Size Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the vertical frame size (height) of the sequence. This attribute can be set using the Sequence.setSettings() method and is read-only. ```JavaScript app.project.sequences[index].frameSizeVertical ``` -------------------------------- ### Get Sequence Horizontal Frame Size Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the horizontal frame size (width) of the sequence. This attribute can be set using the Sequence.setSettings() method and is read-only. ```JavaScript app.project.sequences[index].frameSizeHorizontal ``` -------------------------------- ### Sequence: Link Selection Source: https://ppro-scripting.docsforadobe.dev/print_page Links the currently selected video and audio clips within the sequence. Returns a boolean indicating success. ```JavaScript app.project.sequences[index].linkSelection() ``` -------------------------------- ### Get Project Item Tree Path Source: https://ppro-scripting.docsforadobe.dev/print_page Returns the current location of a project item within the project's hierarchy. This is a read-only string property. ```javascript app.project.rootItem.children[index].treePath ``` -------------------------------- ### Project Manager Options - Convert Synthetics to Clips Source: https://ppro-scripting.docsforadobe.dev/print_page Controls whether clips from synthetic importers are transcoded to new media. If true, specified output presets are used. This is a read/write attribute. ```javascript app.projectManager.options.convertSyntheticsToClips ``` -------------------------------- ### Get Production Lock State Source: https://ppro-scripting.docsforadobe.dev/print_page Returns the lock state of a single project within the Production. Returns true if the project is locked, false otherwise. ```ExtendScript app.production.getLocked(project); ``` -------------------------------- ### Find Items by Media Path - JavaScript Source: https://ppro-scripting.docsforadobe.dev/item/projectitem Returns an array of project items that reference the same media path. Optionally ignores sub-clips. ```javascript app.project.rootItem.children[index].findItemsMatchingMediaPath(pathToMatch, ignoreSubClips) ``` -------------------------------- ### Project Manager Options - Destination Path Source: https://ppro-scripting.docsforadobe.dev/print_page Specifies the destination path for exporting the project and its associated media. This is a read/write attribute. ```javascript app.projectManager.options.destinationPath ``` -------------------------------- ### ProjectItem.clearOutPoint() - JavaScript Source: https://ppro-scripting.docsforadobe.dev/print_page Clears any assigned out point for a project item, causing it to start at its startTime. This method takes no parameters and returns 0 upon successful execution. ```JavaScript app.project.rootItem.children[index].clearOutPoint() ``` -------------------------------- ### Attach Proxy to ProjectItem Source: https://ppro-scripting.docsforadobe.dev/item/projectitem Attaches a proxy file to a ProjectItem. This method takes the media path and a flag indicating if it's a high-resolution proxy. ```Javascript app.project.rootItem.children[index].attachProxy(mediaPath, isHiRes); ``` -------------------------------- ### Convert After Effects Compositions Source: https://ppro-scripting.docsforadobe.dev/general/projectmanager Enables or disables the rendering of dynamically-linked After Effects compositions to new media using a specified output preset. ```JavaScript app.projectManager.options.convertAECompsToClips ``` -------------------------------- ### Get Number of Sequences in Project Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the total number of sequences present in the active Adobe Premiere Pro project. This attribute is read-only and returns an integer. ```JavaScript var sequenceCount = app.project.sequences.numSequences; ``` -------------------------------- ### Get Sequence Work Area In Point (Seconds) Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the current sequence work area in point, expressed in seconds. This method returns the value as a string. ```javascript app.project.sequences[index].getWorkAreaInPoint() ``` -------------------------------- ### Open Premiere Pro Project Document Source: https://ppro-scripting.docsforadobe.dev/application/application Opens a Premiere Pro project file from the specified path. Allows optional parameters to suppress dialogs and manage the MRU list. Returns true if the file was opened successfully. ```JavaScript app.openDocument(path, [suppressConversionDialog], [bypassLocateFileDialog], [bypassWarningDialog], [doNotAddToMRUList]); ``` -------------------------------- ### Get Value at Specific Keyframe for Component Parameter Source: https://ppro-scripting.docsforadobe.dev/print_page Retrieves the value of a component parameter at a specific keyframe time. This function is applicable to parameters that support keyframing. ```javascript app.project.sequences[index].audioTracks[index].clips[index].components[index].properties[index].getValueAtKey(time) ``` ```javascript app.project.sequences[index].videoTracks[index].clips[index].components[index].properties[index].getValueAtKey(time) ``` -------------------------------- ### Set Premiere Pro Scratch Disk Path Source: https://ppro-scripting.docsforadobe.dev/print_page Specifies the directory for Premiere Pro's scratch disks. Accepts a path string and a ScratchDiskType enum value to define which scratch disk to modify. Returns true if the operation is successful. ```JavaScript var scratchPath = Folder.selectDialog('Choose new scratch disk folder'); if (scratchPath && scratchPath.exists) { app.setScratchDiskPath(scratchPath.fsName, ScratchDiskType.FirstAutoSaveFolder); } ```