Render Queue
data-variant=info
data-slots=text
Since: 27.0
The Media Encoder Render Queue API is the used for all operations involving managing the app and render queue.
The RenderQueue object can be acceessed from the main app object:
const app = require("mediaencoder");
const renderQueue = app.RenderQueue;
Constants
These Render Queue Constants are used as parameters in various RenderQueue API methods for Media Encoder.
All Constants can be accessed via the RenderQueue object:
const app = require("mediaencoder");
const renderQueue = app.RenderQueue;
const PROGRESS_CATEGORY_ID = renderQueue.PROGRESS_CATEGORY_ID; // "AMEProgressCategoryRender"
const RENDER_QUEUE_RUNNING = renderQueue.RENDER_QUEUE_RUNNING; // 2
PROGRESS_CATEGORY_ID
Retrieves the unique identifier for the progress category for global progress of the AME renderer. This ID allows access to the global progress of the AME Renderer. To obtain the category, use getOrCreateProgressCategory() on the ProgressCategoryContainer object. The ProgressItem object should be used to manage individual progress items. Each job item is registered using its unique reference ID.
Type: string
Since: 27.0
RENDER_QUEUE_INVALID_STATE
Render queue invalid state.
Type: int
Since: 27.0
RENDER_QUEUE_PAUSED
Render queue paused state.
Type: int
Since: 27.0
RENDER_QUEUE_RUNNING
Render queue running state.
Type: int
Since: 27.0
RENDER_QUEUE_STOPPED
Render queue stopped state.
Type: int
Since: 27.0
RENDER_QUEUE_STOPPING
Render queue stopping state.
Type: int
Since: 27.0
RESULT_ERROR
Validation result when your render job returns an error.
Type: int
Since: 27.0
RESULT_SUCCESS
Validation result when your render job returns successfully.
Type: int
Since: 27.0
RENDER_QUEUE_STATUS_CHANGED
Event ID for when the render queue status changes.
Type: string
Since: 27.0
AUDIO_PREPROGRESS_VALUE_CHANGED
Event ID for when the audio preprogress value changes.
Type: string
Since: 27.0
Methods
enqueueFile
Enqueues a media source with a given RenderOptions object but does NOT start the queue to render. Renders a media source using a specified preset.
This method currently supports transcoding for various file types, including media files, Adobe Premiere project files, and Adobe After Effects project files.
For Premiere & After Effects projects, the first sequence or comp will be added to the queue. In order to specify a different sequence or comp for rendering, see getProjectItemGUIDs() and setSequenceGUID().
Since: 27.0
Parameters
Returns
const app = require("mediaencoder");
const result = await app.RenderQueue.enqueueFile(
"path/to/source.mov",
"path/to/preset.epr",
"path/to/out.mp4",
);
result; // { jobGroupId: string, jobId: string, message: string, outputPath: string, result: number }
enqueueImagesAsSequence
Adds a group of images an image sequence to the render queue. The images will be sorted in alphabetical order by default.
Since: 27.0
Parameters
Returns
const app = require("mediaencoder");
const success = await app.RenderQueue.enqueueImagesAsSequence(
"path/to/imagesequenceFolder",
"path/to/imagesequenceFolder/IMAGE_0001.jpg",
"path/to/preset.epr",
"path/to/output/file.mp4",
);
success; // true
renderFile
Enqueues and immediately renders a media source with the queue to render using a specified source file, preset, and output directory.
This method currently supports transcoding for various file types, including media files, Adobe Premiere project files, and Adobe After Effects project files.
For Premiere & After Effects projects, the first sequence or comp will be added to the queue. In order to specify a different sequence or comp for rendering, see getProjectItemGUIDs() and setSequenceGUID().
Since: 27.0
Parameters
Returns
const app = require("mediaencoder");
const result = await app.RenderQueue.renderFile(
"path/to/source.mov",
"path/to/preset.epr",
"path/to/out.mp4",
);
result; // { jobGroupId: string, jobId: string, message: string, outputPath: string, result: number }
stitchFiles
Enqueues and immediately renders a media source with the queue to render using a specified source file, preset, and output directory.
Since: 27.0
Parameters
Returns
const app = require("mediaencoder");
const result = await app.RenderQueue.stitchFiles(
["path/to/source_a.mov", "path/to/source_b.mov"],
"path/to/preset.epr",
"path/to/out.mp4",
);
result; // { jobGroupId: string, jobId: string, message: string, outputPath: string, result: number }
getInstance
Gets an instance of the RenderQueue object.
Since: 27.0
Parameters
none
Returns
const app = require("mediaencoder");
const instance = app.RenderQueue.getInstance();
instance; // { addEventListener, dispatchEvent, getStatus, removeEventListener, subscribeToEvent }
getJob
Returns a RenderJob object for the given job ID, or null if no matching job is found in the queue.
Since: 27.0
Parameters
renderFile or enqueueFileReturns
RenderJob, or null if no matching job is found.
const app = require("mediaencoder");
const result = await app.RenderQueue.enqueueFile(
"path/to/source.mov",
"path/to/preset.epr",
"path/to/out.mp4",
);
const job = app.RenderQueue.getJob(result.jobId);
getJobGroup
Returns a RenderJobGroup object for the given job group ID, or null if no matching group is found in the queue. A group represents a single source and can contain multiple outputs (RenderJob objects).
Since: 27.0
Parameters
Returns
RenderJobGroup, or null if no matching group is found.
Throws a parameter error if jobGroupId is not a well-formed GUID, or if there is no active render queue to resolve it against.
const app = require("mediaencoder");
const result = await app.RenderQueue.enqueueFile(
"path/to/source.mov",
"path/to/preset.epr",
"path/to/out.mp4",
);
const group = app.RenderQueue.getJobGroup(result.jobGroupId);
getLogOutput
Get the Log Output of a specific render job.
Since: 27.0
Parameters
Returns
const app = require("mediaencoder");
const logOutput = app.RenderQueue.getLogOutput(
"e8105b34-f5f8-4254-84d9-6345120568f4", // jobGroupId
"2ed0087e-da4e-43f2-86b1-f46b04382b10", // jobId
);
logOutput; // '{"error":"","summary":[],"time":"2026-07-29T10:20:56"}'
getMissingAssets
Returns a list of missing asests for a specific render job.
Since: 27.0
Parameters
Returns
const app = require("mediaencoder");
const missingAssets = app.RenderQueue.getMissingAssets(
"0115abc0-37b9-43ea-b192-f6547e57f1d7", // jobGroupId
"1b814929-65b6-4d83-b822-68ce5cd2f741", // jobId
true, // includeSource
true, // includeOutput
);
missingAssets; // [
// "Offline media detected and will be encoded using the Offline Media graphic.",
// "Missing Asset: uhd_3840_2160_60fps.mp4"
// ]
getProjectItemGUIDs
Returns the list of GUIDs for objects ( Premiere sequences or After Effects compositions) at the top/root level.
Since: 27.0
Parameters
Returns
const app = require("mediaencoder");
const res = app.RenderQueue.getProjectItemGUIDs("path/to/project.prproj");
res; // { guids: ["7717fd87-1b69-4290-b5b0-4eb990d7afd8"] }
start
Starts rendering queue. Can be used to continue after a pause.
Since: 27.0
Parameters
none
Returns
const app = require("mediaencoder");
const success = await app.RenderQueue.start();
success; // true
stop
Stops the complete rendering queue including all rendering items.
Since: 27.0
Parameters
none
Returns
const app = require("mediaencoder");
const success = await app.RenderQueue.stop();
success; // true
stopCurrent
Stops the current item, but continues rendering if other items are in the queue.
Since: 27.0
Parameters
none
Returns
const app = require("mediaencoder");
const success = await app.RenderQueue.stopCurrent();
success; // true
pause
Pauses the complete rendering queue including all rendering items.
Since: 27.0
Parameters
none
Returns
const app = require("mediaencoder");
const success = await app.RenderQueue.pause();
success; // true
removeAllJobs
Removes all jobs from the queue. This method can only be called if the rendering is stopped or completed.
Since: 27.0
Parameters
none
Returns
const app = require("mediaencoder");
const success = await app.RenderQueue.removeAllJobs();
success; // true