RenderJobGroup

data-variant=info

data-slots=text
UXP for Adobe Media Encoder is in public beta. This reference is being written, and the supported API surface may change before general availability.

Since: 27.0

A RenderJobGroup represents a single source (media file or project) in the render queue that can drive multiple outputs. Use it to add more outputs that share the same source via addOutput, and to enumerate the outputs already in the group via getOutputs. Each output is returned as a RenderJob.

A RenderJobGroup is obtained via RenderQueue.getJobGroup or RenderJob.getGroup, rather than constructed directly.

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);

Properties

id

GUID of this render job group (its source). Matches RenderJob.groupID for every output it contains.

Type: string (readonly)

Since: 27.0

Methods

addOutput

Adds another output to this group's shared source using the given preset and output path, and returns the new RenderJob. Per-output settings (work area, custom in/out points, rotation) are applied on the returned RenderJob.

Since: 27.0

Parameters

Name
Type
Description
presetFilePath
string
File path to the preset (.epr) file
outputPath
string
File path to the output file

Returns

RenderJob, or null if the group is no longer in the queue or the preset could not be applied.

const app = require("mediaencoder");
const group = app.RenderQueue.getJobGroup(jobGroupId);
const newOutput = group.addOutput("path/to/other-preset.epr", "path/to/other-output.mp4");

getOutputs

Returns the RenderJob outputs currently contained in this group.

Since: 27.0

Parameters

none

Returns

Name
Type
Description
outputs
object[]
Array of RenderJob objects in this group
const app = require("mediaencoder");
const group = app.RenderQueue.getJobGroup(jobGroupId);
const outputs = group.getOutputs();

getOutputCount

Returns the number of outputs currently contained in this group.

Since: 27.0

Parameters

none

Returns

Name
Type
Description
count
number
The number of outputs currently in this group
const app = require("mediaencoder");
const group = app.RenderQueue.getJobGroup(jobGroupId);
group.getOutputCount();

getID

Returns the GUID of this render job group (its source). Equivalent to the id property.

Since: 27.0

Parameters

none

Returns

Name
Type
Description
id
string
GUID of this render job group
const app = require("mediaencoder");
const group = app.RenderQueue.getJobGroup(jobGroupId);
group.getID();