Media Encoder2027
Object

ExporterScriptObject

Contains several encoding methods. You can listen to different types of the AMEExportEvent: onEncodeComplete, onError, onMediaInfoCreated, onBatchItemStatusChanged, onItemEncodingStarted, onEncodingItemProgressUpdated, onAudioPreEncodeProgress, onPostProcessListInitialized

Properties

NameType AccessDescription
Number readonly Returns the encode time in milliseconds.
Varies readonly
Varies readonly

Methods

→ Boolean

Export the source with the provided list of presets. Returns true in case of success.

sourcePath String Media path (Premiere Pro projects aren't supported).
outputPath String If outputPath is empty, then the output file location will be generated based on the source location.
presetsPath String Multiple preset paths can be provided separated via a | (e.g. 'path1|path2|path3'
matchSource? Boolean Optional. Default value is false
→ EncoderWrapper

Export the source with the provided preset. Returns an EncoderWrapper object.

sourcePath String Media path or Premiere Pro project path (In case of a Premiere Pro project the last sequence will be used).
outputPath String If outputPath is empty, then the output file location will be generated based on the source location.
presetPath String
matchSource? Boolean Optional. Default value is false
writeFramesToDisk? Varies Optional. Default value is false. True writes five frames at 0%
arg7 Varies
arg8 Boolean 75% and 100% of the full duration. Known issue, Currently it only works with parallel encoding disabled.
→ Boolean

Export the Premiere Pro sequence with the provided preset. Returns true in case of success.

projectPath String Premiere Pro project path.
outputPath String If outputPath is empty, then the output file location will be generated based on the source location.
presetPath String
matchSource? Boolean Optional. Default value is false.
writeFramesToDisk? Varies Optional. Default value is false. True writes five frames at 0%
arg7 Varies
arg8 Boolean 75% and 100% of the full duration. Known issue, Currently it only works with parallel encoding disabled.
leadingFramesToTrim? Number Optional. Default value is 0.
trailingFramesToTrim? Number Optional. Default value is 0.
sequenceName? String Optional. If sequence name is empty then we use the last sequence of the project.
→ Varies

Remove all batch items from the queue. Returns true in case of success.

arg1 Boolean
→ Boolean

Smart render the source with the provided preset. Returns true in case of success.

sourcePath String Media path or Premiere Pro project path (In case of a Premiere Pro project the last sequence will be used).
outputPath String If outputPath is empty, then the output file location will be generated based on the source location.
presetPath String
matchSource? Boolean Optional. Default value is false.
writeFramesToDisk? Varies Optional. Default value is false. True writes five frames at 0%
arg7 Varies
arg8 Boolean 75% and 100% of the full duration. Known issue, Currently it only works with parallel encoding disabled.
leadingFramesToTrim? Number Optional. Default value is 0.
trailingFramesToTrim? Number Optional. Default value is 0.