Media Encoder API DOM Reference

The Media Encoder API is the host-specific layer Media Encoder adds on top of UXP: render queues, presets, jobs, watch folders, progress reporting, and the scripting hooks used to automate encoding.

Access the API

Load the Media Encoder module from your plugin. From app, you can reach every public Media Encoder API surface. For example, start the render queue with:

const app = require("mediaencoder");
const success = await app.RenderQueue.start();

Browse the API

Area

Use it to

Render Queue

Add sources, inspect jobs, start or stop rendering, and subscribe to queue events

Render Options

Choose presets, output paths, and work-area settings

Watch Folder

Inspect and manage automatic encoding folders

TickTime

Represent precise time values used by render jobs and options

Progress Category Container

Group progress categories and report progress from a plugin

C2PAService

Work with Content Credentials settings and manifest locations

Minimum Version Tags

Properties and methods show the minimum Media Encoder version where the member was introduced or changed significantly. For properties, look for the MIN VERSION column. For methods, the version appears alongside the method documentation.

Synchronous and Asynchronous Access

ExtendScript and CEP calls to Media Encoder were synchronous and could block the application UI. In UXP, most Media Encoder methods are asynchronous and do not block the UI thread. Await methods that return a Promise, or chain them with .then().

Property getters and setters are exposed synchronously for a smoother transition from the ExtendScript DOM and do not need to be awaited.

See the API in a Plugin

The Render Queue Panel sample uses async and await across a working TypeScript plugin. Use it to connect reference entries to real UI actions and queue behavior.