Media Encoder2027
InDesign2027 InDesign Server2025 Illustrator31 PhotoshopCC 2015.5 Bridge2027 Media Encoder2027 Core JavaScriptExtendScript only ScriptUIExtendScript only
Object

FrontendScriptObject

Scripting methods to the frontend

Methods

→ Boolean

Adds the first comp of an After Effects project resp. the first sequence of a Premiere Pro project to the batch.

compPath String Path to e.g. an After Effects project or Premiere Pro project. The first comp resp. sequence will be used.
presetPath? String Optional. If presetPath is empty, then the default preset will be applied.
outputPath? String Optional. If outputPath is empty, then the output file name will be generated based on the comp path.
→ Object

Adds e.g. an After Effects comp or Premiere Pro sequence to the batch and returns an EncoderWrapper object.

projectPath String E.g. Premiere Pro or After Effects project path.
format String E.g. 'H.264'
presetPath String Either a preset or a format input must be present. If no preset is used then the default preset of the specified format will be applied.
guid String The unique id of e.g. a Premiere Pro sequence or After Effects composition.
outputPath? String Optional. If outputPath is empty, then the output file name will be generated based on the project path.
→ Boolean

Adds an image sequence to the batch. The images will be sorted in alphabetical order.

containingFolder String The folder containing image files.
imagePath String All images from the containing folder with the same extension will be added to the output file.
presetPath String
outputPath? String Optional. If outputPath is empty, then the output file name will be generated based on the containingFolder name
→ Object

Adds a file to the batch and returns an EncoderWrapper object.

filePath String File path of a media source.
format String E.g. 'H.264'
presetPath String Either a preset or a format input must be present. If no preset is used then the default preset of the specified format will be applied.
outputPath? String Optional. If outputPath is empty, then the output file name will be generated based on the file path.
→ Boolean

Adds a media source to the batch.

sourcePath String Path of the media source.
→ Object

Adds a team project item to the batch and returns an EncoderWrapper object.

projectsURL String Team Projects URL or Team Projects Snap. You can create a tp2snap file in PPro for a ProjectItem via the scripting API saveProjectSnapshot.
format String E.g. 'H.264'
presetPath String Either a preset or a format input must be present. If no preset is used then the default preset of the specified format will be applied.
outputPath String
→ Boolean

Adds Final Cut Pro xml to the batch.

xmlPath String Path to a Final Cut Pro xml file.
presetPath String
outputFolderPath? String Optional. If outputFolderPath is empty, then the output file name will be generated based on the XML file path.
→ Varies

Returns the list of GUIDs for objects (sequences|comps) at the top|root level.

projectPath String E.g. Premiere Pro or After Effects project path.
→ Object

Adds a batch item for the given media and returns an EncoderWrapper object.

mediaPaths String Semicolon delimited list of media paths.
format String E.g. 'H.264'
presetPath String Either a preset or a format input must be present. If no preset is used then the default preset of the specified format will be applied.
outputPath String
→ Boolean

Stops the batch.