# EncoderManager

Since: **25.6**

## Properties

+---------------------------------------------------------------------+
| Table                                                               |
+:---------------+:----------+:-------+:------------+:----------------+
| Name           | Type      | Access | Min Version | Description     |
+:---------------+:----------+:-------+:------------+:----------------+
| isAMEInstalled | *boolean* | R      | 25.6        | Check if AME is |
|                |           |        |             | installed.      |
+----------------+-----------+--------+-------------+-----------------+

## Static Methods

### getExportFileExtension

Get the Export File Extension of Input Preset file

Since: **25.6**

Returns: Promise<*string*>

#### Parameters

+------------------------------------------------------------------------------------------------+
| Table                                                                                          |
+:---------------+:----------------------------------------------------------------+:------------+
| Name           | Type                                                            | Description |
+:---------------+:----------------------------------------------------------------+:------------+
| sequence       | *[Sequence](/premiere-pro/uxp/ppro-reference/classes/sequence)* | \-          |
+:---------------+:----------------------------------------------------------------+:------------+
| presetFilePath | *string*                                                        | \-          |
+----------------+-----------------------------------------------------------------+-------------+

+----------------+
| Horizontalline |
+----------------+
|                |
+----------------+

### getManager

Get the Encoder Manager object.

Since: **25.6**

Returns: *[EncoderManager](/premiere-pro/uxp/ppro-reference/classes/encodermanager)*

+----------------+
| Horizontalline |
+----------------+
|                |
+----------------+

## Instance Methods

### encodeFile

Encode input media file in AME

Since: **25.6**

Returns: Promise<*boolean*>

#### Parameters

+-------------------------------------------------------------------------------------------------------+
| Table                                                                                                 |
+:----------------------+:----------------------------------------------------------------+:------------+
| Name                  | Type                                                            | Description |
+:----------------------+:----------------------------------------------------------------+:------------+
| filePath              | *string*                                                        | \-          |
+:----------------------+:----------------------------------------------------------------+:------------+
| outputFile            | *string*                                                        | \-          |
+:----------------------+:----------------------------------------------------------------+:------------+
| presetFile            | *string*                                                        | \-          |
+:----------------------+:----------------------------------------------------------------+:------------+
| inPoint               | *[TickTime](/premiere-pro/uxp/ppro-reference/classes/ticktime)* | \-          |
+:----------------------+:----------------------------------------------------------------+:------------+
| outPoint              | *[TickTime](/premiere-pro/uxp/ppro-reference/classes/ticktime)* | \-          |
+:----------------------+:----------------------------------------------------------------+:------------+
| workArea              | *number*                                                        | \-          |
+:----------------------+:----------------------------------------------------------------+:------------+
| removeUponCompletion  | *boolean*                                                       | \-          |
+:----------------------+:----------------------------------------------------------------+:------------+
| startQueueImmediately | *boolean*                                                       | \-          |
+-----------------------+-----------------------------------------------------------------+-------------+

+----------------+
| Horizontalline |
+----------------+
|                |
+----------------+

### encodeProjectItem

Encode input clipProjectItem in AME

Since: **25.6**

Returns: Promise<*boolean*>

#### Parameters

+---------------------------------------------------------------------------------------------------------------------+
| Table                                                                                                               |
+:----------------------+:------------------------------------------------------------------------------+:------------+
| Name                  | Type                                                                          | Description |
+:----------------------+:------------------------------------------------------------------------------+:------------+
| clipProjectItem       | *[ClipProjectItem](/premiere-pro/uxp/ppro-reference/classes/clipprojectitem)* | \-          |
+:----------------------+:------------------------------------------------------------------------------+:------------+
| outputFile            | *string*                                                                      | \-          |
+:----------------------+:------------------------------------------------------------------------------+:------------+
| presetFile            | *string*                                                                      | \-          |
+:----------------------+:------------------------------------------------------------------------------+:------------+
| workArea              | *number*                                                                      | \-          |
+:----------------------+:------------------------------------------------------------------------------+:------------+
| removeUponCompletion  | *boolean*                                                                     | \-          |
+:----------------------+:------------------------------------------------------------------------------+:------------+
| startQueueImmediately | *boolean*                                                                     | \-          |
+-----------------------+-------------------------------------------------------------------------------+-------------+

+----------------+
| Horizontalline |
+----------------+
|                |
+----------------+

### exportSequence

Export a sequence. If no output file and preset is specified, the sequence will be exported with the applied export settings or standard export rules will be applied.

Since: **25.6**

Returns: Promise<*boolean*>

#### Parameters

+-------------------------------------------------------------------------------------------------------------------------------------+
| Table                                                                                                                               |
+:-----------+:---------------------------------------------------------------------------------+:------------------------------------+
| Name       | Type                                                                             | Description                         |
+:-----------+:---------------------------------------------------------------------------------+:------------------------------------+
| sequence   | *[Sequence](/premiere-pro/uxp/ppro-reference/classes/sequence)*                  | \-                                  |
+:-----------+:---------------------------------------------------------------------------------+:------------------------------------+
| exportType | *[Constants.ExportType](/premiere-pro/uxp/ppro-reference/constants/#exporttype)* | Constants.ExportType.IMMEDIATELY,   |
|            |                                                                                  | Constants.ExportType.QUEUE\_TO\_AME |
|            |                                                                                  | etc..                               |
+:-----------+:---------------------------------------------------------------------------------+:------------------------------------+
| outputFile | *string*                                                                         | \-                                  |
+:-----------+:---------------------------------------------------------------------------------+:------------------------------------+
| presetFile | *string*                                                                         | \-                                  |
+:-----------+:---------------------------------------------------------------------------------+:------------------------------------+
| exportFull | *boolean*                                                                        | \-                                  |
+------------+----------------------------------------------------------------------------------+-------------------------------------+

+----------------+
| Horizontalline |
+----------------+
|                |
+----------------+

### launchEncoder

Launch AME asynchronously if not already running.

Since: **26.3**

Returns: Promise<*boolean*>

+----------------+
| Horizontalline |
+----------------+
|                |
+----------------+

### setEmbeddedXMPEnabled

Set whether to enable embedded XMP when exporting a sequence.

Since: **26.3**

Returns: Promise<*boolean*>

#### Parameters

+-----------------------------------+
| Table                             |
+:--------+:----------+:------------+
| Name    | Type      | Description |
+:--------+:----------+:------------+
| enabled | *boolean* | \-          |
+---------+-----------+-------------+

+----------------+
| Horizontalline |
+----------------+
|                |
+----------------+

### setSidecarXMPEnabled

Set whether to enable sidecar XMP when exporting a sequence.

Since: **26.3**

Returns: Promise<*boolean*>

#### Parameters

+-----------------------------------+
| Table                             |
+:--------+:----------+:------------+
| Name    | Type      | Description |
+:--------+:----------+:------------+
| enabled | *boolean* | \-          |
+---------+-----------+-------------+

+----------------+
| Horizontalline |
+----------------+
|                |
+----------------+

### startBatchEncode

Start encoding the AME batch queue.

Since: **26.3**

Returns: Promise<*boolean*>

+----------------+
| Horizontalline |
+----------------+
|                |
+----------------+

## Events

+-------------------------------------------------------------------------+
| Table                                                                   |
+:------------------------+:--------+:------------------------------------+
| Name                    | Version | Description                         |
+:------------------------+:--------+:------------------------------------+
| EVENT\_RENDER\_COMPLETE | 25.6    | Broadcast when AME is finished      |
|                         |         | rendering                           |
+:------------------------+:--------+:------------------------------------+
| EVENT\_RENDER\_ERROR    | 25.6    | Broadcast when AME gives back error |
|                         |         | message                             |
+:------------------------+:--------+:------------------------------------+
| EVENT\_RENDER\_CANCEL   | 25.6    | Broadcast when AME job is canceled  |
+:------------------------+:--------+:------------------------------------+
| EVENT\_RENDER\_QUEUE    | 25.6    | Broadcast when AME job is queued    |
+:------------------------+:--------+:------------------------------------+
| EVENT\_RENDER\_PROGRESS | 25.6    | Broadcast when AME job is rendering |
|                         |         | the job                             |
+-------------------------+---------+-------------------------------------+

+------------------------------------------------------------------------------------------------------------------------------+
| Metadata                                                                                                                     |
+----------------+-------------------------------------------------------------------------------------------------------------+
| title          | EncoderManager                                                                                              |
+----------------+-------------------------------------------------------------------------------------------------------------+
| description    | Overview of EncoderManager                                                                                  |
+----------------+-------------------------------------------------------------------------------------------------------------+
| source         | github                                                                                                      |
+----------------+-------------------------------------------------------------------------------------------------------------+
| pathprefix     | /premiere-pro/uxp                                                                                           |
+----------------+-------------------------------------------------------------------------------------------------------------+
| githubblobpath | https\://github.com/AdobeDocs/uxp-premiere-pro/blob/main/src/pages/ppro-reference/classes/encodermanager.md |
+----------------+-------------------------------------------------------------------------------------------------------------+
| template       | documentation                                                                                               |
+----------------+-------------------------------------------------------------------------------------------------------------+
