# plugins.finalcutpro.export.batch

Timeline Batch Export Plugin.

---

## Submodules
 * [plugins.finalcutpro.export.batch.manager](plugins.finalcutpro.export.batch.manager.md)

---

## API Overview
**Constants** - _Useful values which cannot be changed_
 * [DEFAULT_CUSTOM_FILENAME](#default_custom_filename)

**Functions** - _API calls offered directly by the extension_
 * [batchExport](#batchexport)
 * [batchExportTimelineClips](#batchexporttimelineclips)
 * [changeCustomFilename](#changecustomfilename)
 * [changeExportDestinationFolder](#changeexportdestinationfolder)
 * [changeExportDestinationPreset](#changeexportdestinationpreset)
 * [getDestinationFolder](#getdestinationfolder)
 * [getDestinationPreset](#getdestinationpreset)
 * [performBatchExport](#performbatchexport)

**Fields** - _Variables which can only be accessed from an object returned by a constructor_
 * [customFilename](#customfilename)
 * [destinationPreset](#destinationpreset)
 * [ignoreBackgroundTasks](#ignorebackgroundtasks)
 * [ignoreInvalidCaptions](#ignoreinvalidcaptions)
 * [ignoreMissingEffects](#ignoremissingeffects)
 * [ignoreProxies](#ignoreproxies)
 * [replaceExistingFiles](#replaceexistingfiles)
 * [useCustomFilename](#usecustomfilename)

---

## API Documentation

#### Constants

### [DEFAULT_CUSTOM_FILENAME](#default_custom_filename)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.export.batch.DEFAULT_CUSTOM_FILENAME -> string`                                                                    |
| **Type**                                    | Constant                                                                     |
| **Description**                             | Default Custom Filename                                                                     |
| **Notes**                                   | None |
| **Source**                                  | [src/plugins/finalcutpro/export/batch/batch.lua line 55](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/batch.lua#L55) |

---

#### Functions

### [batchExport](#batchexport)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.export.batch.batchExport() -> boolean`                                                                    |
| **Type**                                    | Function                                                                     |
| **Description**                             | Opens the Batch Export popup.                                                                     |
| **Parameters**                              | <ul><li>None</li></ul> |
| **Returns**                                 | <ul><li>`true` if successful otherwise `false`</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/plugins/finalcutpro/export/batch/batch.lua line 702](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/batch.lua#L702) |

---

### [batchExportTimelineClips](#batchexporttimelineclips)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.export.batch.batchExportTimelineClips(clips) -> boolean`                                                                    |
| **Type**                                    | Function                                                                     |
| **Description**                             | Batch Export Timeline Clips                                                                     |
| **Parameters**                              | <ul><li>clips - table of selected Clips</li></ul> |
| **Returns**                                 | <ul><li>`true` if successful otherwise `false`</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/plugins/finalcutpro/export/batch/batch.lua line 115](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/batch.lua#L115) |

---

### [changeCustomFilename](#changecustomfilename)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.export.batch.changeCustomFilename() -> none`                                                                    |
| **Type**                                    | Function                                                                     |
| **Description**                             | Change Custom Filename String.                                                                     |
| **Parameters**                              | <ul><li>None</li></ul> |
| **Returns**                                 | <ul><li>None</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/plugins/finalcutpro/export/batch/batch.lua line 542](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/batch.lua#L542) |

---

### [changeExportDestinationFolder](#changeexportdestinationfolder)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.export.batch.changeExportDestinationFolder() -> none`                                                                    |
| **Type**                                    | Function                                                                     |
| **Description**                             | Change Export Destination Folder.                                                                     |
| **Parameters**                              | <ul><li>None</li></ul> |
| **Returns**                                 | <ul><li>None</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/plugins/finalcutpro/export/batch/batch.lua line 518](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/batch.lua#L518) |

---

### [changeExportDestinationPreset](#changeexportdestinationpreset)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.export.batch.changeExportDestinationPreset() -> none`                                                                    |
| **Type**                                    | Function                                                                     |
| **Description**                             | Change Export Destination Preset.                                                                     |
| **Parameters**                              | <ul><li>None</li></ul> |
| **Returns**                                 | <ul><li>None</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/plugins/finalcutpro/export/batch/batch.lua line 482](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/batch.lua#L482) |

---

### [getDestinationFolder](#getdestinationfolder)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.export.batch.getDestinationFolder() -> string`                                                                    |
| **Type**                                    | Function                                                                     |
| **Description**                             | Gets the destination folder path.                                                                     |
| **Parameters**                              | <ul><li>None</li></ul> |
| **Returns**                                 | <ul><li>The destination folder path as a string.</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/plugins/finalcutpro/export/batch/batch.lua line 571](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/batch.lua#L571) |

---

### [getDestinationPreset](#getdestinationpreset)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.export.batch.getDestinationPreset() -> string | nil`                                                                    |
| **Type**                                    | Function                                                                     |
| **Description**                             | Gets the destination preset.                                                                     |
| **Parameters**                              | <ul><li>None</li></ul> |
| **Returns**                                 | <ul><li>The destination preset as a string, or `nil` if no preset is set.</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/plugins/finalcutpro/export/batch/batch.lua line 596](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/batch.lua#L596) |

---

### [performBatchExport](#performbatchexport)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.export.batch.performBatchExport() -> none`                                                                    |
| **Type**                                    | Function                                                                     |
| **Description**                             | Performs the Browser Batch Export function.                                                                     |
| **Parameters**                              | <ul><li>None</li></ul> |
| **Returns**                                 | <ul><li>None</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/plugins/finalcutpro/export/batch/batch.lua line 764](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/batch.lua#L764) |

---

#### Fields

### [customFilename](#customfilename)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.export.batch.customFilename <cp.prop: string>`                                                                    |
| **Type**                                    | Field                                                                     |
| **Description**                             | Custom Filename for Batch Export.                                                                     |
| **Notes**                                   | None |
| **Source**                                  | [src/plugins/finalcutpro/export/batch/batch.lua line 90](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/batch.lua#L90) |

---

### [destinationPreset](#destinationpreset)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.export.batch.destinationPreset <cp.prop: boolean>`                                                                    |
| **Type**                                    | Field                                                                     |
| **Description**                             | Destination Preset.                                                                     |
| **Notes**                                   | None |
| **Source**                                  | [src/plugins/finalcutpro/export/batch/batch.lua line 75](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/batch.lua#L75) |

---

### [ignoreBackgroundTasks](#ignorebackgroundtasks)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.export.batch.ignoreBackgroundTasks <cp.prop: boolean>`                                                                    |
| **Type**                                    | Field                                                                     |
| **Description**                             | Defines whether or not a Batch Export should Ignore Background Tasks.                                                                     |
| **Notes**                                   | None |
| **Source**                                  | [src/plugins/finalcutpro/export/batch/batch.lua line 110](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/batch.lua#L110) |

---

### [ignoreInvalidCaptions](#ignoreinvalidcaptions)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.export.batch.ignoreInvalidCaptions <cp.prop: boolean>`                                                                    |
| **Type**                                    | Field                                                                     |
| **Description**                             | Defines whether or not a Batch Export should Ignore Invalid Captions.                                                                     |
| **Notes**                                   | None |
| **Source**                                  | [src/plugins/finalcutpro/export/batch/batch.lua line 100](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/batch.lua#L100) |

---

### [ignoreMissingEffects](#ignoremissingeffects)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.export.batch.ignoreMissingEffects <cp.prop: boolean>`                                                                    |
| **Type**                                    | Field                                                                     |
| **Description**                             | Defines whether or not a Batch Export should Ignore Missing Effects.                                                                     |
| **Notes**                                   | None |
| **Source**                                  | [src/plugins/finalcutpro/export/batch/batch.lua line 95](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/batch.lua#L95) |

---

### [ignoreProxies](#ignoreproxies)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.export.batch.ignoreProxies <cp.prop: boolean>`                                                                    |
| **Type**                                    | Field                                                                     |
| **Description**                             | Defines whether or not a Batch Export should Ignore Proxies.                                                                     |
| **Notes**                                   | None |
| **Source**                                  | [src/plugins/finalcutpro/export/batch/batch.lua line 105](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/batch.lua#L105) |

---

### [replaceExistingFiles](#replaceexistingfiles)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.export.batch.replaceExistingFiles <cp.prop: boolean>`                                                                    |
| **Type**                                    | Field                                                                     |
| **Description**                             | Defines whether or not a Batch Export should Replace Existing Files.                                                                     |
| **Notes**                                   | None |
| **Source**                                  | [src/plugins/finalcutpro/export/batch/batch.lua line 80](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/batch.lua#L80) |

---

### [useCustomFilename](#usecustomfilename)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.export.batch.useCustomFilename <cp.prop: boolean>`                                                                    |
| **Type**                                    | Field                                                                     |
| **Description**                             | Defines whether or not the Batch Export tool should override the clipname with a custom filename.                                                                     |
| **Notes**                                   | None |
| **Source**                                  | [src/plugins/finalcutpro/export/batch/batch.lua line 85](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/export/batch/batch.lua#L85) |

---

---

<script src="https://giscus.app/client.js"
        data-repo="CommandPost/CommandPost"
        data-repo-id="MDEwOlJlcG9zaXRvcnk3NDY0NTk2NQ=="
        data-category="Website Discussion"
        data-category-id="DIC_kwDOBHMBzc4CXFFA"
        data-mapping="pathname"
        data-strict="0"
        data-reactions-enabled="1"
        data-emit-metadata="0"
        data-input-position="bottom"
        data-theme="dark"
        data-lang="en"
        crossorigin="anonymous"
        async>
</script>
