# plugins.finalcutpro.export.batch.manager
Manager for the Batch Export Window.
---
## Submodules
* [plugins.finalcutpro.export.batch.manager.panel](plugins.finalcutpro.export.batch.manager.panel.md)
---
## API Overview
**Constants** - _Useful values which cannot be changed_
* [DEFAULT_HEIGHT](#default_height)
* [DEFAULT_WIDTH](#default_width)
* [lastTab](#lasttab)
* [position](#position)
* [WEBVIEW_LABEL](#webview_label)
**Variables** - _Configurable values_
* [_handlers](#_handlers)
* [_panels](#_panels)
**Functions** - _API calls offered directly by the extension_
* [addHandler](#addhandler)
* [addPanel](#addpanel)
* [disabledPanels](#disabledpanels)
* [getHandler](#gethandler)
* [getLabel](#getlabel)
* [getWebview](#getwebview)
* [hide](#hide)
* [init](#init)
* [injectScript](#injectscript)
* [maxPanelHeight](#maxpanelheight)
* [new](#new)
* [refresh](#refresh)
* [selectPanel](#selectpanel)
* [setPanelRenderer](#setpanelrenderer)
* [show](#show)
---
## API Documentation
#### Constants
### [DEFAULT_HEIGHT](#default_height)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.finalcutpro.export.batch.manager.DEFAULT_HEIGHT -> number` |
| **Type** | Constant |
| **Description** | Default Height of Preferences Window |
| **Notes** | None |
| **Source** | [src/plugins/finalcutpro/export/batch/manager/init.lua line 39](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/manager/init.lua#L39) |
---
### [DEFAULT_WIDTH](#default_width)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.finalcutpro.export.batch.manager.DEFAULT_WIDTH -> number` |
| **Type** | Constant |
| **Description** | Default Width of Preferences Window |
| **Notes** | None |
| **Source** | [src/plugins/finalcutpro/export/batch/manager/init.lua line 44](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/manager/init.lua#L44) |
---
### [lastTab](#lasttab)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.finalcutpro.export.batch.manager.lastTab` |
| **Type** | Constant |
| **Description** | Returns the last tab saved in settings. |
| **Notes** | None |
| **Source** | [src/plugins/finalcutpro/export/batch/manager/init.lua line 64](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/manager/init.lua#L64) |
---
### [position](#position)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.finalcutpro.export.batch.manager.position` |
| **Type** | Constant |
| **Description** | Returns the last frame saved in settings. |
| **Notes** | None |
| **Source** | [src/plugins/finalcutpro/export/batch/manager/init.lua line 59](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/manager/init.lua#L59) |
---
### [WEBVIEW_LABEL](#webview_label)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.finalcutpro.export.batch.manager.WEBVIEW_LABEL -> string` |
| **Type** | Constant |
| **Description** | The WebView Label |
| **Notes** | None |
| **Source** | [src/plugins/finalcutpro/export/batch/manager/init.lua line 34](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/manager/init.lua#L34) |
---
#### Variables
### [_handlers](#_handlers)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.finalcutpro.export.batch.manager._handlers -> table` |
| **Type** | Variable |
| **Description** | Table containing handlers. |
| **Notes** | None |
| **Source** | [src/plugins/finalcutpro/export/batch/manager/init.lua line 54](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/manager/init.lua#L54) |
---
### [_panels](#_panels)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.finalcutpro.export.batch.manager._panels -> table` |
| **Type** | Variable |
| **Description** | Table containing panels. |
| **Notes** | None |
| **Source** | [src/plugins/finalcutpro/export/batch/manager/init.lua line 49](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/manager/init.lua#L49) |
---
#### Functions
### [addHandler](#addhandler)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.finalcutpro.export.batch.manager.addHandler(id, handlerFn) -> string` |
| **Type** | Function |
| **Description** | Adds a Handler |
| **Parameters** | - id - The ID
- handlerFn - the handler function
|
| **Returns** | |
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/finalcutpro/export/batch/manager/init.lua line 95](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/manager/init.lua#L95) |
---
### [addPanel](#addpanel)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.finalcutpro.export.batch.manager.addPanel(params) -> plugins.finalcutpro.export.batch.manager.panel` |
| **Type** | Function |
| **Description** | Adds a new panel with the specified `params` to the Batch Export manager. |
| **Parameters** | - `params` - The parameters table. Details below.
|
| **Returns** | - The new `panel` instance.
|
| **Notes** | - The `params` can have the following properties. The `priority` and `id` and properties are **required**.
- ** `priority` - An integer value specifying the priority of the panel compared to others.
- ** `id` - A string containing the unique ID of the panel.
- ** `label` - The human-readable label for the panel icon.
- ** `image` - The `hs.image` for the panel icon.
- ** `tooltip` - The human-readable details for the toolbar icon when the mouse is hovering over it.
- ** `closeFn` - A callback function that's triggered when the Preferences window is closed.
|
| **Examples** | None |
| **Source** | [src/plugins/finalcutpro/export/batch/manager/init.lua line 525](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/manager/init.lua#L525) |
---
### [disabledPanels](#disabledpanels)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.finalcutpro.export.batch.manager.disabledPanels(ids) -> none` |
| **Type** | Function |
| **Description** | Sets which panels are disabled. |
| **Parameters** | - ids - A table of panel ID's to disable
|
| **Returns** | |
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/finalcutpro/export/batch/manager/init.lua line 451](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/manager/init.lua#L451) |
---
### [getHandler](#gethandler)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.finalcutpro.export.batch.manager.getHandler(id) -> string` |
| **Type** | Function |
| **Description** | Returns the handler for a given ID. |
| **Parameters** | |
| **Returns** | |
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/finalcutpro/export/batch/manager/init.lua line 109](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/manager/init.lua#L109) |
---
### [getLabel](#getlabel)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.finalcutpro.export.batch.manager.getLabel() -> string` |
| **Type** | Function |
| **Description** | Returns the Webview label. |
| **Parameters** | |
| **Returns** | - The Webview label as a string.
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/finalcutpro/export/batch/manager/init.lua line 82](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/manager/init.lua#L82) |
---
### [getWebview](#getwebview)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.finalcutpro.export.batch.manager.getWebview() -> hs.webview` |
| **Type** | Function |
| **Description** | Returns the Webview of the Preferences Window. |
| **Parameters** | |
| **Returns** | |
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/finalcutpro/export/batch/manager/init.lua line 69](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/manager/init.lua#L69) |
---
### [hide](#hide)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.finalcutpro.export.batch.manager.hide() -> none` |
| **Type** | Function |
| **Description** | Hides the Batch Export Window. |
| **Parameters** | |
| **Returns** | |
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/finalcutpro/export/batch/manager/init.lua line 395](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/manager/init.lua#L395) |
---
### [init](#init)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.finalcutpro.export.batch.manager.init() -> nothing` |
| **Type** | Function |
| **Description** | Initialises the preferences panel. |
| **Parameters** | |
| **Returns** | |
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/finalcutpro/export/batch/manager/init.lua line 229](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/manager/init.lua#L229) |
---
### [injectScript](#injectscript)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.finalcutpro.export.batch.manager.injectScript(script) -> none` |
| **Type** | Function |
| **Description** | Injects JavaScript into the Batch Export Webview. |
| **Parameters** | - script - The JavaScript code you want to inject in the form of a string.
|
| **Returns** | |
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/finalcutpro/export/batch/manager/init.lua line 431](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/manager/init.lua#L431) |
---
### [maxPanelHeight](#maxpanelheight)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.finalcutpro.export.batch.manager.maxPanelHeight() -> number` |
| **Type** | Function |
| **Description** | Returns the maximum size defined by a panel. |
| **Parameters** | |
| **Returns** | - The maximum panel height.
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/finalcutpro/export/batch/manager/init.lua line 244](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/manager/init.lua#L244) |
---
### [new](#new)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.finalcutpro.export.batch.manager.new() -> none` |
| **Type** | Function |
| **Description** | Creates a new Preferences Window. |
| **Parameters** | |
| **Returns** | |
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/finalcutpro/export/batch/manager/init.lua line 285](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/manager/init.lua#L285) |
---
### [refresh](#refresh)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.finalcutpro.export.batch.manager.refresh() -> none` |
| **Type** | Function |
| **Description** | Refreshes the Batch Export Window. |
| **Parameters** | |
| **Returns** | |
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/finalcutpro/export/batch/manager/init.lua line 415](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/manager/init.lua#L415) |
---
### [selectPanel](#selectpanel)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.finalcutpro.export.batch.manager.selectPanel(id) -> none` |
| **Type** | Function |
| **Description** | Selects a Batch Export Panel. |
| **Parameters** | - id - the ID of the panel you want to select.
|
| **Returns** | |
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/finalcutpro/export/batch/manager/init.lua line 464](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/manager/init.lua#L464) |
---
### [setPanelRenderer](#setpanelrenderer)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.finalcutpro.export.batch.manager.setPanelRenderer(renderer) -> none` |
| **Type** | Function |
| **Description** | Sets a Panel Renderer |
| **Parameters** | |
| **Returns** | |
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/finalcutpro/export/batch/manager/init.lua line 122](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/manager/init.lua#L122) |
---
### [show](#show)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.finalcutpro.export.batch.manager.show() -> boolean` |
| **Type** | Function |
| **Description** | Shows the Preferences Window |
| **Parameters** | |
| **Returns** | - True if successful or nil if an error occurred
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/finalcutpro/export/batch/manager/init.lua line 369](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/manager/init.lua#L369) |
---
---