Encoder object
Encoder object
Section titled “Encoder object”app.encoder
Description
Section titled “Description”The encoder object represents Adobe Media Encoder, and is used for local rendering, outside of Premiere Pro.
app.encoder is broken on Premiere Pro 14.3.1 - 15 on Mac only. Fixed in 22 and up. See here.
Attributes
Section titled “Attributes”None.
Methods
Section titled “Methods”Encoder.encodeFile()
Section titled “Encoder.encodeFile()”app.encoder.encodeFile(filePath, outputPath, presetPath, workArea, removeUponCompletion, inPoint, outPoint)
Description
Section titled “Description”Makes Adobe Media Encoder render (optionally, a specified range from) the specified file, with the specified settings.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
filePath | String | A path to a file to render. |
outputPath | String | A path to an output file. |
presetPath | String | A path to a preset (.epr) file. |
workArea | Integer | Integer denoting work area to be used: |
- 0 - ENCODE_ENTIRE | ||
- 1 - ENCODE_IN_TO_OUT | ||
- 2 - ENCODE_WORK_AREA | ||
removeUponCompletion | Integer | If 1, job will be removed once complete. |
inPoint | Time object | A Time object, for the in point of new file. |
outPoint | Time object | A Time object, for the out point of new file. |
Returns
Section titled “Returns”Returns a job ID as a String, for the render job added to the AME queue, or 0 if unsuccessful.
Encoder.encodeProjectItem()
Section titled “Encoder.encodeProjectItem()”app.encoder.encodeProjectItem(projectItem, outputPath, presetPath, workArea, removeUponCompletion)
Description
Section titled “Description”Makes Adobe Media Encoder render (optionally, a specified range from) the specified ProjectItem object, with the specified settings.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
projectItem | ProjectItem object | A project item to render. |
outputPath | String | A path to an output file. |
presetPath | String | A path to a preset (.epr) file. |
workArea | Integer | Integer denoting work area to be used: |
- 0 - ENCODE_ENTIRE | ||
- 1 - ENCODE_IN_TO_OUT | ||
- 2 - ENCODE_WORK_AREA | ||
removeUponCompletion | Integer | If 1, job will be removed once complete. |
Returns
Section titled “Returns”Returns a job ID as a String, for the render job added to the AME queue, or 0 if unsuccessful.
Encoder.encodeSequence()
Section titled “Encoder.encodeSequence()”app.encoder.encodeSequence(sequence, outputPath, presetPath, workArea, removeUponCompletion)
Description
Section titled “Description”Makes Adobe Media Encoder render the specified Sequence object, with the specified settings.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
sequence | Sequence object | A sequence to render. |
outputPath | String | A path to an output file. |
presetPath | String | A path to a preset (.epr) file. |
workArea | Integer | Integer denoting work area to be used: |
- 0 - ENCODE_ENTIRE | ||
- 1 - ENCODE_IN_TO_OUT | ||
- 2 - ENCODE_WORK_AREA | ||
removeUponCompletion | Integer | If 1, job will be removed once complete. |
Returns
Section titled “Returns”Returns a job ID as a String, for the render job added to the AME queue, or 0 if unsuccessful.
Encoder.launchEncoder()
Section titled “Encoder.launchEncoder()”app.encoder.launchEncoder()
Description
Section titled “Description”Launches Adobe Media Encoder.
Parameters
Section titled “Parameters”None.
Returns
Section titled “Returns”Returns 0 if successful.
Encoder.setEmbeddedXMPEnabled()
Section titled “Encoder.setEmbeddedXMPEnabled()”app.encoder.setEmbeddedXMPEnabled(enabled)
Description
Section titled “Description”Determines whether embedded XMP metadata, will be output.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
enabled | Integer | Pass 1 to enable sidecar output, 0 to disable. |
Returns
Section titled “Returns”Returns 0 if successful.
Encoder.setSidecarXMPEnabled()
Section titled “Encoder.setSidecarXMPEnabled()”app.encoder.setSidecarXMPEnabled(enabled)
Description
Section titled “Description”Determines whether a sidecar file containing XMP metadata, will be output.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
enabled | Integer | Pass 1 to enable sidecar output, 0 to disable. |
Returns
Section titled “Returns”Returns 0 if successful.
Encoder.startBatch()
Section titled “Encoder.startBatch()”app.encoder.startBatch()
Description
Section titled “Description”Makes Adobe Media Encoder start rendering its render queue.
Parameters
Section titled “Parameters”None.
Returns
Section titled “Returns”Returns 0 if successful.