Preset

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 Preset represents an export preset: a named set of encoding settings for an export format. Use it to read the identity, format, and settings of a preset, and to get the file path that the RenderQueue methods expect as presetFilePath.

A Preset is returned by the PresetManager methods, rather than constructed directly. All Preset members are instance methods.

const app = require("mediaencoder");
const [preset] = app.PresetManager.getPresetsForFormat("H.264");
preset.getDisplayName();
await app.RenderQueue.renderFile("path/to/source.mov", preset.getFilePath(), "path/to/out.mp4");

Methods

getDisplayName

Returns the display name of the preset, localized to the language of the Media Encoder user interface.

Since: 27.0

Parameters

none

Returns

Name
Type
Description
displayName
string
The display name of the preset
const app = require("mediaencoder");
const [preset] = app.PresetManager.getPresetsForFormat("H.264");
preset.getDisplayName();

getMatchName

Returns the match name of the preset, which identifies the preset in code.

Since: 27.0

Parameters

none

Returns

Name
Type
Description
matchName
string
The match name of the preset
const app = require("mediaencoder");
const [preset] = app.PresetManager.getPresetsForFormat("H.264");
preset.getMatchName();

getID

Returns the unique ID (GUID) of the preset. Pass it to PresetManager.findPresetByID to find the preset again later.

Since: 27.0

Parameters

none

Returns

Name
Type
Description
id
string
The GUID of the preset
const app = require("mediaencoder");
const [preset] = app.PresetManager.getPresetsForFormat("H.264");
const presetId = preset.getID();
app.PresetManager.findPresetByID(presetId);

getFolderDisplayPath

Returns the folder path under which the preset is organized in the Media Encoder user interface.

Since: 27.0

Parameters

none

Returns

Name
Type
Description
folderDisplayPath
string
The folder path of the preset in the preset browser
const app = require("mediaencoder");
const [preset] = app.PresetManager.getPresetsForFormat("H.264");
preset.getFolderDisplayPath();

getFilePath

Returns the full path to the preset file on disk. Pass it as presetFilePath to RenderQueue.renderFile, RenderQueue.enqueueFile, or the other render methods.

Since: 27.0

Parameters

none

Returns

Name
Type
Description
filePath
string
The full path to the preset file
const app = require("mediaencoder");
const [preset] = app.PresetManager.getPresetsForFormat("H.264");
await app.RenderQueue.enqueueFile("path/to/source.mov", preset.getFilePath(), "path/to/out.mp4");

getFormatName

Returns the name of the export format of the preset.

Since: 27.0

Parameters

none

Returns

Name
Type
Description
formatName
string
The export format name, such as "H.264" or "QuickTime"
const app = require("mediaencoder");
const preset = app.PresetManager.loadPresetFromFile("path/to/preset.epr");
preset.getFormatName(); // "H.264"

getPresetType

Returns where the preset comes from: "system" for a preset that comes with Media Encoder, or "custom" for a preset that a user created. Presets loaded with PresetManager.loadPresetFromFile are "custom".

Since: 27.0

Parameters

none

Returns

Name
Type
Description
presetType
string
"system" or "custom"
const app = require("mediaencoder");
const systemPresets = app.PresetManager.getPresetsForFormat("H.264").filter(
  (preset) => preset.getPresetType() === "system",
);

isIngestPreset

Returns whether the preset is an ingest preset. Ingest presets can't be used for watch folder outputs, see WatchFolder.addOutput.

Since: 27.0

Parameters

none

Returns

Name
Type
Description
isIngest
boolean
true if the preset is an ingest preset
const app = require("mediaencoder");
const preset = app.PresetManager.loadPresetFromFile("path/to/preset.epr");
preset.isIngestPreset(); // false

getComments

Returns the comments of the preset, localized to the language of the Media Encoder user interface.

Since: 27.0

Parameters

none

Returns

Name
Type
Description
comments
string
The comments of the preset
const app = require("mediaencoder");
const preset = app.PresetManager.loadPresetFromFile("path/to/preset.epr");
preset.getComments();

getSummaryJSON

Returns a summary of all settings of the preset, including the video, audio, and encoding parameters, as a JSON string.

Since: 27.0

Parameters

none

Returns

Name
Type
Description
summary
string
JSON string with the settings of the preset
const app = require("mediaencoder");
const preset = app.PresetManager.loadPresetFromFile("path/to/preset.epr");
const summary = JSON.parse(preset.getSummaryJSON());