### Install types-for-adobe-extras Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/index.md Install the library using npm. This command is used for project setup. ```bash npm install types-for-adobe-extras ``` -------------------------------- ### Full Code Profiling Example Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/codeprofiler.md Demonstrates a complete workflow for profiling a section of code, including resetting, starting, performing operations, stopping, and retrieving results. ```typescript qe.codeProfiler.reset(); qe.codeProfiler.start(); // Perform operations to profile const sequence = qe.project.getActiveSequence(); const track = sequence.getVideoTrackAt(0); for (let i = 0; i < track.numItems; i++) { const item = track.getItemAt(i); // Do work } qe.codeProfiler.stop(); // Get timing results const profileResults = qe.codeProfiler.get(); console.log(`Profile results: ${profileResults}`); ``` -------------------------------- ### CodeProfiler.start() Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/codeprofiler.md Starts the code profiler to begin recording performance metrics. ```APIDOC ## start() ### Description Starts the code profiler. ### Method ```typescript start(): any ``` ### Example ```typescript qe.codeProfiler.start(); ``` ``` -------------------------------- ### play() Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeplayer.md Starts playback of the sequence from the current playhead position. ```APIDOC ## play() ### Description Starts playback of the sequence from the current playhead position. ### Method `any` ### Returns `any` ### Example ```typescript const sequence = qe.project.getActiveSequence(); sequence.player.play(); ``` ``` -------------------------------- ### Start Scrubbing Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeplayer.md Enters a mode that allows the playhead to be dragged manually. ```typescript const sequence = qe.project.getActiveSequence(); sequence.player.startScrubbing(); ``` -------------------------------- ### save() Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeproject.md Saves the current project. Includes an example of how to use it and check the success status. ```APIDOC ## save() ### Description Save the current project. ### Method `save` ### Returns - **boolean** - Success indicator ### Request Example ```typescript const saved = qe.project.save(); if (saved) { console.log('Project saved'); } ``` ``` -------------------------------- ### QEPlayer Usage Example Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeplayer.md Demonstrates enabling statistics, playing a sequence, checking performance metrics, and disabling statistics. Includes a warning for dropped frames. ```typescript const sequence = qe.project.getActiveSequence(); const player = sequence.player; // Enable performance monitoring player.enableStatistics(); // Play the sequence player.play(); // Wait for playback to complete or stop it // (actual wait implementation depends on your script) // player.stop(); // Check performance metrics console.log(`Total frames played: ${player.totalFrames}`); console.log(`Dropped frames: ${player.droppedFrames}`); console.log(`Audio dropouts: ${player.audioDropouts}`); console.log(`Avg device load: ${player.audioDeviceLoadAvg}%`); // If significant dropped frames detected if (parseInt(player.droppedFrames) > 0) { console.log('WARNING: Dropped frames detected during playback'); } // Disable monitoring player.disableStatistics(); ``` -------------------------------- ### Full Multicam Usage Example Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/multicam.md Demonstrates how to enable, play, change cameras, record, and stop a multicam sequence using the Multicam interface. ```typescript const sequence = qe.project.getActiveSequence(); // Check if sequence has multicam if (sequence.multicam) { // Enable multicam mode sequence.multicam.enable(); // Start playback sequence.multicam.play(); // Change camera during playback // (This would typically be called in response to user input) // sequence.multicam.changeCamera(); // Record the switches sequence.multicam.record(); // Stop playback sequence.multicam.stop(); } ``` -------------------------------- ### Get Audio Transition List Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeproject.md Retrieves a list of available audio transitions. ```typescript getAudioTransitionList(pp0?: boolean): string[] ``` -------------------------------- ### Example Usage of MediaType Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/types.md Shows how to use MediaType constants to delete all preview files or specifically video preview files from the project. ```typescript // Delete all preview files qe.project.deletePreviewFiles("FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF"); // Delete only video preview files qe.project.deletePreviewFiles("228CDA18-3625-4d2d-951E-348879E4ED93"); ``` -------------------------------- ### Access and Manipulate Project Items Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeprojectitem.md This example demonstrates iterating through project items in a bin, accessing their properties, checking their status, and performing basic operations like opening in source and renaming. ```typescript // Access and manipulate project items const bin = qe.project.getBinAt(0); for (let i = 0; i < bin.numItems; i++) { const item = bin.getItemAt(i); console.log(`Item: ${item.name}`); console.log(`Source: ${item.filePath}`); console.log(`Offline: ${item.isOffline()}`); // Check media properties via clip const clip = item.clip; if (!item.isOffline() && clip) { console.log(` Duration: ${clip.duration}`); console.log(` Size: ${clip.videoFrameWidth}x${clip.videoFrameHeight}`); } // Wait for pending operations to complete while (item.isPending() || item.isIndexing()) { qe.wait(); } // Open in source monitor item.openInSource(); // Rename item item.rename(`${item.name}_v2`); } ``` -------------------------------- ### beginDroppedFrameLogging() Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeapplication.md Starts logging dropped frames during playback in Adobe Premiere Pro. ```APIDOC ## beginDroppedFrameLogging() ### Description Starts logging dropped frames during playback. ### Method N/A (TypeScript method) ### Endpoint N/A (TypeScript method) ### Parameters None ### Request Example ```typescript qe.beginDroppedFrameLogging(); ``` ### Response #### Success Response N/A (void return type implied) #### Response Example N/A ``` -------------------------------- ### sizeOnDisk() Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeproject.md Gets the current project's file size on disk. ```APIDOC ## sizeOnDisk() ### Description Get the project file size. ### Method `sizeOnDisk` ### Returns - **number** - Size in bytes ``` -------------------------------- ### Example Usage of AudioChannelType Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/types.md Demonstrates how to use the AudioChannelType when adding tracks to a sequence, specifying stereo audio. ```typescript // Create a sequence with stereo audio tracks sequence.addTracks(1, 0, 2, AudioChannelType, 0, 0, 1, 0); ``` -------------------------------- ### getConflicts Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeea.md Get list of unresolved sync conflicts. ```APIDOC ## getConflicts() ### Description Get list of unresolved sync conflicts. ### Method N/A (TypeScript method) ### Endpoint N/A ### Parameters None ### Request Example None ### Response #### Success Response - **Conflicts** (any) - Array of conflict objects ### Response Example None ``` -------------------------------- ### Start Code Profiler Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/codeprofiler.md Initiates the performance profiling session. Call this before the code you want to measure. ```typescript qe.codeProfiler.start(); ``` -------------------------------- ### Get Sequence Presets Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeapplication.md Retrieves a list of all available presets for creating new sequences. ```typescript getSequencePresets(): any ``` -------------------------------- ### Start Playback Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeplayer.md Initiates playback of the sequence from the current playhead position. Ensure a sequence is active before calling. ```typescript const sequence = qe.project.getActiveSequence(); sequence.player.play(); ``` -------------------------------- ### Begin Dropped Frame Logging Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeapplication.md Starts the process of logging dropped frames during video playback. ```typescript beginDroppedFrameLogging(): any ``` -------------------------------- ### Track Usage Example Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/track.md Demonstrates common operations on a video track, including accessing its name and clips, and checking its lock status. Also shows how to lock an audio track. ```typescript const sequence = qe.project.getActiveSequence(); // Access video track const videoTrack = sequence.getVideoTrackAt(0); console.log(`Track name: ${videoTrack.name}`); console.log(`Number of clips: ${videoTrack.numItems}`); // Get first clip on track const firstClip = videoTrack.getItemAt(0); if (firstClip.type === "Clip") { console.log(`First clip duration: ${firstClip.duration}`); } // Check if track is locked if (!videoTrack.isLocked()) { // Perform edits } // Lock audio tracks to prevent accidental changes const audioTrack = sequence.getAudioTrackAt(0); audioTrack.setLock(); ``` -------------------------------- ### Master Clip Usage Example Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qemasterclip.md Demonstrates how to access various properties of a master clip, including video and audio details, caption information, and setting in/out points. Ensure the master clip object is available before accessing its properties. ```typescript // Access source media properties const masterClip = qe.source.clip; if (masterClip) { console.log(`Media: ${masterClip.name}`); console.log(`Duration: ${masterClip.duration}`); // Video properties if (masterClip.videoFrameWidth) { console.log(`Resolution: ${masterClip.videoFrameWidth}x${masterClip.videoFrameHeight}`); console.log(`Framerate: ${masterClip.videoFrameRate} fps`); } // Audio properties if (masterClip.audioNumChannels) { console.log(`Audio: ${masterClip.audioNumChannels} channels`); console.log(`Sample rate: ${masterClip.audioFrameRate} Hz`); } // Check for captions if (masterClip.containsCaptions()) { console.log(`Caption streams: ${masterClip.numCaptioningStreams()}`); } // Set in/out points masterClip.setInPoint('00:00:05:00'); masterClip.setOutPoint('00:01:00:00'); } ``` -------------------------------- ### Get Bin by Index Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeproject.md Retrieves a bin from the project using its numerical index. ```typescript getBinAt(pp0: number): QEProjectItemContainer ``` -------------------------------- ### Clip Boundaries Methods Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/method-reference.md Methods for setting the start and end positions of clips on the timeline. ```APIDOC ## QETrackItem Methods ### `setStartPosition()` - **Purpose**: Set clip start on timeline - **Parameters**: - `p0` (number) - `p1` (number) - **Returns**: `boolean` ### `setEndPosition()` - **Purpose**: Set clip end on timeline - **Parameters**: - `p0` (number) - `p1` (number) - **Returns**: `boolean` ### `setStartPercent()` - **Purpose**: Set source in-point as % - **Parameters**: - `p0` (number) - **Returns**: `boolean` ### `setEndPercent()` - **Purpose**: Set source out-point as % - **Parameters**: - `p0` (number) - **Returns**: `boolean` ``` -------------------------------- ### isCollaborationOnly Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeea.md Check if this is a collaboration-only setup. ```APIDOC ## isCollaborationOnly() ### Description Check if this is a collaboration-only setup. ### Method N/A (TypeScript method) ### Endpoint N/A ### Parameters None ### Request Example None ### Response #### Success Response - **Collaboration status** (any) - Boolean status ### Response Example None ``` -------------------------------- ### QEApplication Global Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/types.md The main entry point to the QE DOM API, providing access to project and application-level functionalities. ```APIDOC ## Global Declaration: qe ### Description The main entry point to the QE DOM API. It may be `undefined` if the QE API is not available. ### Usage Always check if `qe` exists before using. ### Example ```typescript if (qe) { const project = qe.project; const sequence = project.getActiveSequence(); } ``` **Important Notes:** - `qe` may be `undefined` if the QE API is not available - Always check if `qe` exists before using - These are Adobe-internal unsupported APIs ``` -------------------------------- ### getURL() Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeea.md Get the collaboration server URL. ```APIDOC ## getURL() ### Description Get the collaboration server URL. ### Method (Not specified, likely a method call) ### Endpoint (Not applicable for SDK methods) ### Parameters (None) ### Request Example (Not applicable for SDK methods) ### Response #### Success Response - **URL** (string) - The collaboration server URL. ### Response Example (Not specified) ``` -------------------------------- ### getInviteList Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeea.md Get pending invitations to collaborate. ```APIDOC ## getInviteList() ### Description Get pending invitations to collaborate. ### Method N/A (TypeScript method) ### Endpoint N/A ### Parameters None ### Request Example None ### Response #### Success Response - **Invitations** (any) - Array of invitations ### Response Example None ``` -------------------------------- ### startScrubbing() Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeplayer.md Enters scrubbing mode, allowing the playhead to be dragged. ```APIDOC ## startScrubbing() ### Description Enters scrubbing mode, allowing the playhead to be dragged. ### Method `any` ### Returns `any` ``` -------------------------------- ### getUsername Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeea.md Get the username of the logged-in user. ```APIDOC ## getUsername() ### Description Get the username of the logged-in user. ### Method N/A (TypeScript method) ### Endpoint N/A ### Parameters None ### Request Example None ### Response #### Success Response - **Username** (any) - Username string ### Response Example None ``` -------------------------------- ### Get Project Size on Disk Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeproject.md Returns the current size of the project file on disk in bytes. Returns a number. ```typescript sizeOnDisk(): number ``` -------------------------------- ### getProcessID() Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeea.md Get the process ID of the collaboration service. ```APIDOC ## getProcessID() ### Description Get the process ID of the collaboration service. ### Method (Not specified, likely a method call) ### Endpoint (Not applicable for SDK methods) ### Parameters (None) ### Request Example (Not applicable for SDK methods) ### Response #### Success Response - **Process ID** (any) - The process ID of the collaboration service. ### Response Example (Not specified) ``` -------------------------------- ### Accessing QEApplication and Project Properties Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeapplication.md This snippet demonstrates how to access the QEApplication interface, retrieve the current project, and log the application version. It includes a check to ensure the 'qe' object is available. ```typescript if (qe) { // Get the current project const project = qe.project; const projectName = project.name; // Access the active sequence const sequence = project.getActiveSequence(); // Check application version const version = qe.version; console.log(`Premiere Pro ${version}`); // Enable performance logging for debugging qe.enablePerformanceLogging(); } ``` -------------------------------- ### Check for Collaboration-Only Setup Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeea.md Determine if the Premiere Pro instance is configured for collaboration-only mode. Returns a boolean status. ```typescript isCollaborationOnly(): any ``` -------------------------------- ### getArchivedProductionList Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeea.md Get list of archived Team Projects. ```APIDOC ## getArchivedProductionList() ### Description Get list of archived Team Projects. ### Method N/A (TypeScript method) ### Endpoint N/A ### Parameters None ### Request Example None ### Response #### Success Response - **Archived productions** (any) - Array of archived productions ### Response Example None ``` -------------------------------- ### getLoggedInUserDisplayId Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeea.md Get the display ID of the logged-in user. ```APIDOC ## getLoggedInUserDisplayId() ### Description Get the display ID of the logged-in user. ### Method N/A (TypeScript method) ### Endpoint N/A ### Parameters None ### Request Example None ### Response #### Success Response - **User display ID** (any) - User display ID ### Response Example None ``` -------------------------------- ### Create Proxy for Project Item Media Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeprojectitem.md Use this method to create a proxy file for the project item's media. Requires the proxy format/preset name and the output path for the proxy file. Returns a boolean indicating success. ```typescript item.createProxy("H.264", "/path/to/proxy.mp4"); ``` -------------------------------- ### setStartPercent Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qetrackitem.md Sets the clip's start point as a percentage of the source duration. This allows for precise in-point setting relative to the source. ```APIDOC ## setStartPercent() ### Description Set the clip's start point as a percentage of the source. ### Method N/A (TypeScript method) ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Parameters #### p0 - **p0** (number) - Yes - Percentage (0-100) ### Returns - **boolean** - Success indicator ``` -------------------------------- ### getDiscoveryURL Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeea.md Get the discovery URL for finding collaboration servers. ```APIDOC ## getDiscoveryURL() ### Description Get the discovery URL for finding collaboration servers. ### Method N/A (TypeScript method) ### Endpoint N/A ### Parameters None ### Request Example None ### Response #### Success Response - **Discovery URL** (any) - URL string ### Response Example None ``` -------------------------------- ### Get Available Renderer Names Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeproject.md Retrieves a list of all available video renderer names. Returns an array of strings. ```typescript getRendererNames(): string[] ``` -------------------------------- ### getLoggedInDataServerVersion Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeea.md Get the data server version for the logged-in account. ```APIDOC ## getLoggedInDataServerVersion() ### Description Get the data server version for the logged-in account. ### Method N/A (TypeScript method) ### Endpoint N/A ### Parameters None ### Request Example None ### Response #### Success Response - **Version** (any) - Version string ### Response Example None ``` -------------------------------- ### newBin() Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeproject.md Creates a new bin within the project with the specified name. ```APIDOC ## newBin() ### Description Create a new bin in the project. ### Method POST (conceptual) ### Endpoint /qe/project/bins ### Parameters #### Request Body - **name** (string) - Required - Bin name ### Response #### Success Response (201) - **QEProjectItemContainer** - The newly created bin ``` -------------------------------- ### setStartPosition Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qetrackitem.md Sets the clip's start position on the timeline. Specify the time in ticks or frames to define where the clip begins. ```APIDOC ## setStartPosition() ### Description Set the clip's start position on the timeline. ### Method N/A (TypeScript method) ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Parameters #### p0 - **p0** (number) - Yes - Start time (ticks or frames) #### p1 - **p1** (number) - Yes - Unknown parameter ### Returns - **boolean** - Success indicator ``` -------------------------------- ### Get Audio Transition by Name Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeproject.md Retrieves a specific audio transition object using its name. An unknown boolean parameter is also available. ```typescript getAudioTransitionByName(pp0: string, pp1?: boolean): object ``` -------------------------------- ### Create New Team Project Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeea.md Initiate the creation of a new Team Project. This method is used to start a new collaborative project. ```typescript createProduction(): any ``` -------------------------------- ### Get List of Team Projects (Productions) Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeea.md Fetch a list of all available Team Projects, also referred to as productions, that the user has access to. Returns an array of production objects. ```typescript getProductionList(): any ``` -------------------------------- ### Get Video Transition List Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeproject.md Retrieves a list of available video transitions. Can be filtered by a numeric type and an unknown boolean parameter. ```typescript getVideoTransitionList(pp0?: number, pp1?: boolean): string[] ``` -------------------------------- ### step() Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeplayer.md Advances playback by one frame. ```APIDOC ## step() ### Description Advances playback by one frame. ### Method `any` ### Returns `any` ``` -------------------------------- ### getRemoteServerBuildVersion Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeea.md Get the build version of the Team Projects server. ```APIDOC ## getRemoteServerBuildVersion() ### Description Get the build version of the Team Projects server. ### Method N/A (TypeScript method) ### Endpoint N/A ### Parameters None ### Request Example None ### Response #### Success Response - **Version** (any) - Version string ### Response Example None ``` -------------------------------- ### getSessionSyncStatus Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeea.md Get the sync status of the current editing session. ```APIDOC ## getSessionSyncStatus() ### Description Get the sync status of the current editing session. ### Method N/A (TypeScript method) ### Endpoint N/A ### Parameters None ### Request Example None ### Response #### Success Response - **Sync status** (any) - Sync status object ### Response Example None ``` -------------------------------- ### Iterate Through Project Items and Bins Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/index.md Iterates through all bins in the project, listing each bin's name and then the name and media properties (duration, resolution) of each item within the bin. Requires 'qe' to be defined. ```typescript if (qe) { // Iterate through bins and items const numBins = qe.project.numBins; for (let i = 0; i < numBins; i++) { const bin = qe.project.getBinAt(i); console.log(`Bin: ${bin.name}`); // List items in bin for (let j = 0; j < bin.numItems; j++) { const item = bin.getItemAt(j); console.log(` Item: ${item.name}`); // Access media properties const clip = item.clip; if (clip) { console.log(` Duration: ${clip.duration}`); if (clip.videoFrameWidth) { console.log(` Resolution: ${clip.videoFrameWidth}x${clip.videoFrameHeight}`); } } } } } ``` -------------------------------- ### getProductionList Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeea.md Get list of available Team Projects (productions). ```APIDOC ## getProductionList() ### Description Get list of available Team Projects (productions). ### Method N/A (TypeScript method) ### Endpoint N/A ### Parameters None ### Request Example None ### Response #### Success Response - **Productions** (any) - Array of production objects ### Response Example None ``` -------------------------------- ### importFiles() Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeproject.md Imports media files into the project. Requires an array of file paths and two boolean flags. ```APIDOC ## importFiles() ### Description Import media files into the project. ### Method POST (conceptual) ### Endpoint /qe/project/import ### Parameters #### Request Body - **filePaths** (any[]) - Required - Array of file paths to import - **flag1** (boolean) - Required - Unknown parameter - **flag2** (boolean) - Required - Unknown parameter ### Response #### Success Response (200) - **boolean** - Success indicator ``` -------------------------------- ### QEProjectItemContainer Methods Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeprojectitemcontainer.md This section details the methods available on the QEProjectItemContainer interface for navigating and managing project bins. ```APIDOC ## getBinAt() ### Description Get a sub-bin by index. ### Method `getBinAt` ### Parameters #### Path Parameters - **index** (number) - Required - The index of the sub-bin to retrieve. ### Returns - **QEProjectItemContainer** - The sub-bin object. ## getItemAt() ### Description Get a project item by index. ### Method `getItemAt` ### Parameters #### Path Parameters - **index** (number) - Required - The index of the project item to retrieve. ### Returns - **QEProjectItem** - The project item object. ## getSequenceAt() ### Description Get a sequence by index. ### Method `getSequenceAt` ### Parameters #### Path Parameters - **index** (number) - Required - The index of the sequence to retrieve. ### Returns - **object** - The sequence object. ## getSequenceItemAt() ### Description Get a sequence item by index. ### Method `getSequenceItemAt` ### Parameters #### Path Parameters - **index** (number) - Required - The index of the sequence item to retrieve. ### Returns - **object** - The sequence item object. ## newBin() ### Description Create a new sub-bin within this container. ### Method `newBin` ### Parameters #### Path Parameters - **name** (string) - Required - The name for the new bin. ### Returns - **boolean** - `true` if the bin was created successfully, `false` otherwise. ## flushCache() ### Description Clear cached data for this bin. ### Method `flushCache` ### Returns - **boolean** - `true` if the cache was flushed successfully, `false` otherwise. ``` -------------------------------- ### getRemainingMetadataCacheIndexCount() Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeproject.md Gets the number of pending operations for indexing the metadata cache. ```APIDOC ## getRemainingMetadataCacheIndexCount() ### Description Get the count of remaining metadata cache indexing operations. ### Method `getRemainingMetadataCacheIndexCount` ### Returns - **number** - Count of pending metadata cache operations ``` -------------------------------- ### createProxy Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeprojectitem.md Creates a proxy file for the media associated with the project item. Returns a boolean indicating success. ```APIDOC ## createProxy() ### Description Create a proxy file for the media. ### Method ```typescript createProxy(pp0: string, pp1: string): boolean ``` ### Parameters #### Path Parameters - **pp0** (string) - Required - Proxy format/preset name - **pp1** (string) - Required - Output path for proxy file ### Returns - **boolean** - Success indicator ``` -------------------------------- ### Get Current Position Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeplayer.md Retrieves the current position of the playhead on the timeline. ```typescript const sequence = qe.project.getActiveSequence(); const currentPosition = sequence.player.getPosition(); ``` -------------------------------- ### renderAll() Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/sequence.md Renders the entire sequence. ```APIDOC ## renderAll() ### Description Renders the entire sequence. ### Method Not specified (assumed to be part of a class/object) ### Endpoint Not applicable (SDK method) ### Parameters None ``` -------------------------------- ### getBinAt() Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeproject.md Retrieves a bin from the project by its index. ```APIDOC ## getBinAt() ### Description Get a bin by index. ### Method GET (conceptual) ### Endpoint /qe/project/bins/{index} ### Parameters #### Path Parameters - **index** (number) - Required - Bin index ### Response #### Success Response (200) - **QEProjectItemContainer** - The bin object ``` -------------------------------- ### Get Sequence by Index Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeproject.md Retrieves a sequence from the project using its numerical index. ```typescript getSequenceAt(pp0: number): Sequence ``` -------------------------------- ### QEMasterClip Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/types.md Provides properties for source media, including file details, duration, frame dimensions, frame rate, and audio information. It also allows setting in/out points and managing subclips. ```APIDOC ## QEMasterClip ### Description Source media properties interface. Provides detailed information about the source media file and allows setting in/out points. ### Key Properties (read-only) - `name` (string) - Media file name - `filePath` (string) - File path - `duration` (string) - Duration - `videoFrameWidth` (number) - Width pixels - `videoFrameHeight` (number) - Height pixels - `videoFrameRate` (number) - Frame rate - `videoHasAlpha` (boolean) - Alpha channel - `audioNumChannels` (number) - Channel count - `audioFrameRate` (number) - Sample rate - `audioSampleSize` (number) - Bit depth ### Key Methods - `setInPoint(timecode): boolean` - Set in-point - `setOutPoint(timecode): boolean` - Set out-point - `clearInPoint(): boolean` - Clear in-point - `clearOutPoint(): boolean` - Clear out-point - `numOfChildClips(): number` - Subclip count - `containsCaptions(): boolean` - Has captions - `numCaptioningStreams(): number` - Caption streams See: [QEMasterClip Reference](api-reference/qemasterclip.md) ``` -------------------------------- ### API Reference Structure Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/MANIFEST.txt The API reference is organized into several files, with `api-reference/` containing detailed documentation for each interface. Each interface's documentation includes an overview, properties table, public methods with TypeScript signatures, parameter details, return types, usage examples, and cross-references. ```APIDOC ## API Reference Files Each API reference file (e.g., `qeapplication.md`, `qeproject.md`) provides the following: - **Overview**: A description of the interface. - **Properties Table**: Lists properties with their name, type, and description. - **Public Methods**: Includes the full TypeScript signature, parameter table (name, type, required, default, description), return type documentation, usage examples, and cross-references. - **Usage Examples**: Real-world examples demonstrating how to use the interface. - **See Also**: Cross-references to related interfaces or documentation sections. ``` -------------------------------- ### startPlayback() Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeapplication.md Begins playback in the current sequence within Adobe Premiere Pro. ```APIDOC ## startPlayback() ### Description Begins playback in the current sequence. ### Method N/A (TypeScript method) ### Endpoint N/A (TypeScript method) ### Parameters None ### Request Example ```typescript qe.startPlayback(); ``` ### Response #### Success Response N/A (void return type implied) #### Response Example N/A ``` -------------------------------- ### Create a New Sequence Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/index.md Creates a new sequence in the project using a specified preset. Verifies the existence of 'qe' and checks if the sequence was successfully created. ```typescript if (qe) { // Create a sequence with a preset const created = qe.project.newSequence( 'New Timeline', '/path/to/preset.sqpreset' ); if (created) { const seq = qe.project.getActiveSequence(); console.log(`Created: ${seq.name}`); } } ``` -------------------------------- ### getModalWindowID() Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeapplication.md Gets the window ID of any open modal dialog in Adobe Premiere Pro. ```APIDOC ## getModalWindowID() ### Description Gets the window ID of any open modal dialog. ### Method N/A (TypeScript method) ### Endpoint N/A (TypeScript method) ### Parameters None ### Request Example ```typescript const modalId = qe.getModalWindowID(); console.log(modalId); ``` ### Response #### Success Response `any` - The window ID of the modal dialog. #### Response Example N/A ``` -------------------------------- ### Import Media Files Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeproject.md Imports media files into the project. Requires an array of file paths and two boolean flags. ```typescript importFiles(pp0: any[], pp1: boolean, pp2: boolean): boolean ``` -------------------------------- ### Get Sequence Item by Index Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeproject.md Retrieves a sequence item using its numerical index. ```typescript getSequenceItemAt(pp0: number): SequenceItem ``` -------------------------------- ### Get Project Item by Index Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeproject.md Retrieves a project item using its numerical index. ```typescript getItemAt(pp0: number): object ``` -------------------------------- ### captureAudioDeviceLoad() Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeplayer.md Samples and records the current CPU load of the audio device. ```APIDOC ## captureAudioDeviceLoad() ### Description Samples and records the current CPU load of the audio device. ### Method `any` ### Returns `any` ``` -------------------------------- ### Get Number of Subclips in Use Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qemasterclip.md Retrieves the count of subclips that are currently active on sequences. ```typescript numOfChildClipsInUse(): number ``` -------------------------------- ### importAllAEComps() Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeproject.md Imports all compositions from a specified After Effects project file. ```APIDOC ## importAllAEComps() ### Description Imports all compositions from an After Effects project. ### Method `importAllAEComps` ### Parameters #### Path Parameters - **pp0** (string) - Required - Path to .aep file ### Returns - **boolean** - Success indicator ``` -------------------------------- ### Get Number of Subclips Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qemasterclip.md Retrieves the total count of subclips created from this master clip. ```typescript numOfChildClips(): number ``` -------------------------------- ### QEApplication Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/types.md The root interface for interacting with Premiere Pro's Quality Engineering DOM. It provides access to project, source, enterprise account features, and code profiling tools. ```APIDOC ## Interface: QEApplication ### Description Provides access to Premiere Pro's Quality Engineering DOM, serving as the main entry point for various operations and data retrieval. ### Key Properties - `project` (QEProject): Access to the current project's properties and methods. - `source` (QESource): Access to the source monitor media information. - `ea` (QEEA): Interface for Enterprise Account operations. - `codeProfiler` (CodeProfiler): Tools for performance profiling. ### Key Methods - `startPlayback()`: Begins media playback. - `stopPlayback()`: Stops media playback. - `newProject()`: Creates a new project. - `outputToConsole(text: string)`: Outputs debug information to the console. ### See Also - [QEApplication Reference](api-reference/qeapplication.md) ``` -------------------------------- ### Set Timeline In-Point Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/sequence.md Defines the start point for a selected range or operation on the timeline. ```typescript setInPoint(): any ``` -------------------------------- ### Create New Project Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeapplication.md Use this method to initiate the creation of a new project within Adobe Premiere Pro. ```typescript newProject(): any ``` -------------------------------- ### QESource Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/types.md Represents the Source monitor interface, providing access to playback controls and source media properties. ```APIDOC ## QESource ### Description Represents the Source monitor interface. Provides access to playback control and source media properties. ### Properties - `player` (QEPlayer) - Playback control - `clip` (QEMasterClip) - Source media properties ### Methods - `openFilePath()` - Open file browser See: [QESource Reference](api-reference/qesource.md) ``` -------------------------------- ### setInPoint Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qemasterclip.md Sets the in-point (start point) for the clip using a timecode or frame number. ```APIDOC ## setInPoint() ### Description Sets the in-point (start point) for the clip. ### Method ```typescript setInPoint(pp0: string): boolean ``` ### Parameters #### Path Parameters - **pp0** (string) - Required - Timecode or frame number ### Returns - **boolean** - Success indicator ``` -------------------------------- ### createProduction Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeea.md Create a new Team Project. ```APIDOC ## createProduction() ### Description Create a new Team Project. ### Method N/A (TypeScript method) ### Endpoint N/A ### Parameters None ### Request Example None ### Response #### Success Response None ### Response Example None ``` -------------------------------- ### benchmarkReflectEverything Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeea.md Perform a full sync benchmark operation. ```APIDOC ## benchmarkReflectEverything() ### Description Perform a full sync benchmark operation. ### Method N/A (TypeScript method) ### Endpoint N/A ### Parameters None ### Request Example None ### Response #### Success Response None ### Response Example None ``` -------------------------------- ### Get Debug Database Entry Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeapplication.md Retrieves specific information from the application's debug database. ```typescript getDebugDatabaseEntry(): any ``` -------------------------------- ### Get QEComponent Parameter List Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qecomponent.md Retrieves a list of available parameters for a given effect component. ```typescript getParamList(): any ``` -------------------------------- ### openProduction Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeea.md Open an existing Team Project. ```APIDOC ## openProduction() ### Description Open an existing Team Project. ### Method N/A (TypeScript method) ### Endpoint N/A ### Parameters None ### Request Example None ### Response #### Success Response None ### Response Example None ``` -------------------------------- ### QEPlayer Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/types.md Controls playback and monitoring within the Source monitor. Allows starting/stopping playback, stepping frames, scrubbing, and enabling/disabling statistics. ```APIDOC ## QEPlayer ### Description Playback control and monitoring interface. Allows control over playback and retrieval of playback statistics. ### Key Properties - `loopPlayback` (boolean) - Loop playback setting - `droppedFrames` (string) - Dropped frame count - `totalFrames` (string) - Total frames played - `audioDropouts` (number) - Dropout count - `audioDeviceLoadAvg` (number) - Average device load - `audioDeviceLoadMax` (number) - Max device load ### Key Methods - `play()` - Start playback - `stop()` - Stop playback - `step()` - Next frame - `scrubTo(timecode)` - Go to position - `enableStatistics()` - Start metrics - `disableStatistics()` - Stop metrics - `clearAudioDropoutStatus()` - Reset counters See: [QEPlayer Reference](api-reference/qeplayer.md) ``` -------------------------------- ### Get Modal Window ID Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeapplication.md Retrieves the unique identifier for any currently displayed modal dialog window. ```typescript getModalWindowID(): any ``` -------------------------------- ### Access and Iterate Project Bins and Items Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeprojectitemcontainer.md This snippet demonstrates how to access the number of bins and items within a project, iterate through them, and retrieve their names and counts. It also shows how to create a new bin. ```typescript const numBins = qe.project.numBins; for (let i = 0; i < numBins; i++) { const bin = qe.project.getBinAt(i); console.log(`Bin: ${bin.name}`); console.log(`Items: ${bin.numItems}`); console.log(`Sequences: ${bin.numSequences}`); // Access items in bin for (let j = 0; j < bin.numItems; j++) { const item = bin.getItemAt(j); console.log(` Item: ${item.name}`); } // Access sub-bins for (let j = 0; j < bin.numBins; j++) { const subBin = bin.getBinAt(j); console.log(` Sub-bin: ${subBin.name}`); } } // Create a new bin const newBin = qe.project.newBin("My Clips"); if (newBin) { console.log("Bin created successfully"); } ``` -------------------------------- ### Iterate and Log QEComponents on a Clip Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qecomponent.md Demonstrates how to access and log the name and match name of all effect components present on a clip, along with their parameters. ```typescript // Access effect components on a clip const clip = sequence.getVideoTrackAt(0).getItemAt(0); // Get all components on the clip for (let i = 0; i < clip.numComponents; i++) { const component = clip.getComponentAt(i); console.log(`Effect: ${component.name}`); console.log(`Match name: ${component.matchName}`); // Get parameter list const params = component.getParamList(); console.log(`Parameters: ${params}`); } ``` -------------------------------- ### Get Undo Stack Index Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeproject.md Retrieves the current position within the undo stack. Returns a number. ```typescript undoStackIndex(): number ``` -------------------------------- ### Get Metadata Cache Size Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeproject.md Retrieves the total size of the metadata cache in bytes. Returns a number. ```typescript getMetadataSize(): number ``` -------------------------------- ### open() Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeapplication.md Opens a file or project in Adobe Premiere Pro. ```APIDOC ## open() ### Description Opens a file or project. ### Method N/A (TypeScript method) ### Endpoint N/A (TypeScript method) ### Parameters None ### Request Example ```typescript qe.open(); ``` ### Response #### Success Response N/A (void return type implied) #### Response Example N/A ``` -------------------------------- ### Get Audio Effect List Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeproject.md Retrieves a list of available audio effects. Can be filtered by effect type. ```typescript getAudioEffectList(peffectType?: number, pp1?: boolean): string[] ``` -------------------------------- ### Get Video Effect List Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeproject.md Retrieves a list of available video effects. Can be filtered by effect type. ```typescript const effects = qe.project.getVideoEffectList(); effects.forEach(effect => console.log(effect)); ``` -------------------------------- ### Get Active Sequence Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeproject.md Retrieves the currently active sequence object. This is useful for further manipulation of the active timeline. ```typescript const activeSeq = qe.project.getActiveSequence(); console.log(`Active sequence: ${activeSeq.name}`); ``` -------------------------------- ### Project Creation & Management Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/method-reference.md Methods for creating, saving, and managing projects and their components like sequences and bins. ```APIDOC ## newProject() ### Description Creates a new project. ### Method `newProject()` ### Class QEApplication ### Purpose Create a new project ``` ```APIDOC ## save() ### Description Saves the current project. ### Method `save()` ### Class QEProject ### Purpose Save current project ``` ```APIDOC ## newSequence() ### Description Creates a new sequence with a specified name and preset. ### Method `newSequence(name: string, pathToPreset: string)` ### Class QEProject ### Purpose Create new sequence with preset ``` ```APIDOC ## newBin() ### Description Creates a new project bin. ### Method `newBin(pp0: string)` ### Class QEProject ### Purpose Create new project bin ``` ```APIDOC ## open() ### Description Opens a file or project dialog. ### Method `open()` ### Class QEApplication ### Purpose Open file/project dialog ``` -------------------------------- ### Render & Preview Methods Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/method-reference.md Methods for rendering previews and the entire sequence, as well as managing preview files. ```APIDOC ## Sequence Methods ### `renderPreview()` - **Purpose**: Render preview for sequence ### `renderAll()` - **Purpose**: Render entire sequence ### `renderAudio()` - **Purpose**: Render only audio ### `deletePreviewFiles()` - **Purpose**: Delete cached preview files ``` -------------------------------- ### Get QEComponent Parameter Value Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qecomponent.md Retrieves the current value of a specific parameter within an effect component. ```typescript getParamValue(): any ``` -------------------------------- ### Set Work In-Point Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/sequence.md Sets the work-in point, which defines the start of a work area for specific operations. ```typescript setWorkInPoint(): any ``` -------------------------------- ### newProject() Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeapplication.md Creates a new project in Adobe Premiere Pro. ```APIDOC ## newProject() ### Description Creates a new project. ### Method N/A (TypeScript method) ### Endpoint N/A (TypeScript method) ### Parameters None ### Request Example ```typescript qe.newProject(); ``` ### Response #### Success Response N/A (void return type implied) #### Response Example N/A ``` -------------------------------- ### newSequence Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeproject.md Creates a new sequence within the project, utilizing a specified preset file for its settings. This allows for consistent sequence creation based on predefined configurations. ```APIDOC ## newSequence ### Description Create a new sequence using a preset. ### Method `newSequence(name: string, pathToPreset: string): boolean` ### Parameters #### Path Parameters - **name** (string) - Yes - Name for the new sequence - **pathToPreset** (string) - Yes - Full path to sequence preset file (.sqpreset) ### Returns `boolean` - `true` if sequence created successfully ### Example ```typescript const success = qe.project.newSequence('Rough Cut', '/path/to/preset.sqpreset'); if (success) { console.log('Sequence created'); } ``` ``` -------------------------------- ### CodeProfiler Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/types.md Interface for performance profiling, allowing developers to start, stop, reset, and retrieve profiling data. ```APIDOC ## Interface: CodeProfiler ### Description An interface for profiling code performance within the Premiere Pro environment. ### Methods - `start()`: Begins the code profiling session. - `stop()`: Ends the current profiling session. - `reset()`: Clears all collected profiling data. - `get()`: Retrieves the profiling results. ### See Also - [CodeProfiler Reference](api-reference/codeprofiler.md) ``` -------------------------------- ### Iterate and Access Sequence Items Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/sequenceitem.md Demonstrates how to iterate through sequence items in a bin, log their names, wait for pending operations, and open them in the Source monitor. ```typescript // Access sequence items in project panel const bin = qe.project.getBinAt(0); for (let i = 0; i < bin.numSequences; i++) { const seqItem = bin.getSequenceItemAt(i); console.log(`Sequence: ${seqItem.name}`); // Wait for any pending operations while (seqItem.isPending() || seqItem.isIndexing()) { qe.wait(); } // Open in source monitor seqItem.openInSource(); } ``` -------------------------------- ### getAudioTransitionList() Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeproject.md Retrieves a list of all available audio transitions. ```APIDOC ## getAudioTransitionList() ### Description Get list of available audio transitions. ### Method GET (conceptual) ### Endpoint /qe/project/audioTransitions ### Parameters #### Query Parameters - **pp0** (boolean) - Optional - Unknown parameter ### Response #### Success Response (200) - **string[]** - Array of transition names ``` -------------------------------- ### Reset Code Profiler Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/codeprofiler.md Clears any previously collected profiling data. Use this to start fresh measurements. ```typescript qe.codeProfiler.reset(); ``` -------------------------------- ### openInSource Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeprojectitem.md Opens the project item in the Source monitor. Returns a boolean indicating success. ```APIDOC ## openInSource() ### Description Open the item in the Source monitor. ### Method ```typescript openInSource(): boolean ``` ### Returns - **boolean** - Success indicator ``` -------------------------------- ### Check for Hosted Collaboration Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeea.md Verify if the collaboration features are hosted in the cloud. This indicates whether the setup is cloud-based or on-premises. ```typescript isHostedCollaborationOnly(): any ``` -------------------------------- ### play() Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/multicam.md Play the multicam sequence. This method initiates the playback of the multicam sequence, allowing for real-time editing of camera angles. ```APIDOC ## play() ### Description Play the multicam sequence. ### Method invoke ### Parameters None ### Response None specified ``` -------------------------------- ### Open File or Project Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qeapplication.md This method is used to open an existing file or project in Adobe Premiere Pro. ```typescript open(): any ``` -------------------------------- ### Get Unrendered Timecodes Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/sequence.md Retrieves timecodes for segments marked with red render status bars, indicating they are unrendered. ```typescript getRedBarTimes(): any ``` -------------------------------- ### openFilePath() Source: https://github.com/docsforadobe/types-for-adobe-extras/blob/master/_autodocs/api-reference/qesource.md Opens a file browser dialog, allowing the user to select media files to be loaded into the Source monitor. ```APIDOC ## openFilePath() ### Description Opens a file browser to select media for the source monitor. ### Method ``` any ``` ### Endpoint ``` openFilePath() ``` ### Parameters None ### Response #### Success Response - **any**: The result of the file selection operation. ```