# plugins.finalcutpro.watchfolders.fcpxml Final Cut Pro FCPXML Watch Folder Plugin. --- ## API Overview **Constants** - _Useful values which cannot be changed_ * [SECONDS_UNTIL_DELETE](#seconds_until_delete) **Variables** - _Configurable values_ * [automaticallyImport](#automaticallyimport) * [deleteAfterImport](#deleteafterimport) * [disableImport](#disableimport) * [filesInTransit](#filesintransit) * [notifications](#notifications) * [savedNotifications](#savednotifications) * [watchFolders](#watchfolders) * [watchFolderTableID](#watchfoldertableid) **Functions** - _API calls offered directly by the extension_ * [addWatchFolder](#addwatchfolder) * [controllerCallback](#controllercallback) * [createNotification](#createnotification) * [generateTable](#generatetable) * [importFile](#importfile) * [init](#init) * [insertFilesIntoFinalCutPro](#insertfilesintofinalcutpro) * [newWatcher](#newwatcher) * [refreshTable](#refreshtable) * [removeWatcher](#removewatcher) * [setupWatchers](#setupwatchers) * [styleSheet](#stylesheet) * [watchFolderTriggered](#watchfoldertriggered) --- ## API Documentation #### Constants ### [SECONDS_UNTIL_DELETE](#seconds_until_delete) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `plugins.finalcutpro.watchfolders.fcpxml.SECONDS_UNTIL_DELETE -> number` | | **Type** | Constant | | **Description** | Seconds until a file is deleted. | | **Notes** | None | | **Source** | [src/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 31](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/watchfolders/fcpxml/init.lua#L31) | --- #### Variables ### [automaticallyImport](#automaticallyimport) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `plugins.finalcutpro.watchfolders.fcpxml.automaticallyImport ` | | **Type** | Variable | | **Description** | Boolean that sets whether or not new generated voice file are automatically added to the timeline or not. | | **Notes** | None | | **Source** | [src/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 61](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/watchfolders/fcpxml/init.lua#L61) | --- ### [deleteAfterImport](#deleteafterimport) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `plugins.finalcutpro.watchfolders.fcpxml.deleteAfterImport ` | | **Type** | Variable | | **Description** | Boolean that sets whether or not you want to delete file after they've been imported. | | **Notes** | None | | **Source** | [src/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 71](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/watchfolders/fcpxml/init.lua#L71) | --- ### [disableImport](#disableimport) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `plugins.finalcutpro.watchfolders.fcpxml.disableImport -> boolean` | | **Type** | Variable | | **Description** | When `true` Notifications will no longer be triggered. | | **Notes** | None | | **Source** | [src/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 56](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/watchfolders/fcpxml/init.lua#L56) | --- ### [filesInTransit](#filesintransit) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `plugins.finalcutpro.watchfolders.fcpxml.filesInTransit -> table` | | **Type** | Variable | | **Description** | Files currently being copied | | **Notes** | None | | **Source** | [src/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 41](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/watchfolders/fcpxml/init.lua#L41) | --- ### [notifications](#notifications) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `plugins.finalcutpro.watchfolders.fcpxml.notifications -> table` | | **Type** | Variable | | **Description** | Table of Notifications | | **Notes** | None | | **Source** | [src/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 51](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/watchfolders/fcpxml/init.lua#L51) | --- ### [savedNotifications](#savednotifications) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `plugins.finalcutpro.watchfolders.fcpxml.savedNotifications ` | | **Type** | Variable | | **Description** | Table of Notifications that are saved between restarts | | **Notes** | None | | **Source** | [src/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 66](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/watchfolders/fcpxml/init.lua#L66) | --- ### [watchFolders](#watchfolders) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `plugins.finalcutpro.watchfolders.fcpxml.watchFolders ` | | **Type** | Variable | | **Description** | Table of the users watch folders. | | **Notes** | None | | **Source** | [src/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 76](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/watchfolders/fcpxml/init.lua#L76) | --- ### [watchFolderTableID](#watchfoldertableid) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `plugins.finalcutpro.watchfolders.fcpxml.watchFolderTableID -> string` | | **Type** | Variable | | **Description** | Watch Folder Table ID | | **Notes** | None | | **Source** | [src/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 36](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/watchfolders/fcpxml/init.lua#L36) | --- #### Functions ### [addWatchFolder](#addwatchfolder) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `plugins.finalcutpro.watchfolders.fcpxml.addWatchFolder() -> none` | | **Type** | Function | | **Description** | Opens the "Add Watch Folder" Dialog. | | **Parameters** |
  • None
| | **Returns** |
  • None
| | **Notes** | None | | **Examples** | None | | **Source** | [src/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 559](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/watchfolders/fcpxml/init.lua#L559) | --- ### [controllerCallback](#controllercallback) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `plugins.finalcutpro.watchfolders.fcpxml.controllerCallback(id, params) -> none` | | **Type** | Function | | **Description** | Callback Controller | | **Parameters** |
  • id - ID as string
  • params - table of Parameters
| | **Returns** |
  • None
| | **Notes** | None | | **Examples** | None | | **Source** | [src/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 170](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/watchfolders/fcpxml/init.lua#L170) | --- ### [createNotification](#createnotification) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `plugins.finalcutpro.watchfolders.fcpxml.createNotification(file) -> none` | | **Type** | Function | | **Description** | Creates a new notification | | **Parameters** |
  • file - File name
| | **Returns** |
  • None
| | **Notes** | None | | **Examples** | None | | **Source** | [src/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 408](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/watchfolders/fcpxml/init.lua#L408) | --- ### [generateTable](#generatetable) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `plugins.finalcutpro.watchfolders.fcpxml.generateTable() -> string` | | **Type** | Function | | **Description** | Generate HTML Table | | **Parameters** |
  • None
| | **Returns** |
  • Returns a HTML table as a string
| | **Notes** | None | | **Examples** | None | | **Source** | [src/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 81](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/watchfolders/fcpxml/init.lua#L81) | --- ### [importFile](#importfile) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `plugins.finalcutpro.watchfolders.fcpxml.importFile(file, obj) -> none` | | **Type** | Function | | **Description** | Imports a file into Final Cut Pro | | **Parameters** |
  • file - File name
  • tag - The notification tag
| | **Returns** |
  • None
| | **Notes** | None | | **Examples** | None | | **Source** | [src/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 337](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/watchfolders/fcpxml/init.lua#L337) | --- ### [init](#init) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `plugins.finalcutpro.watchfolders.fcpxml.init(deps, env) -> table` | | **Type** | Function | | **Description** | Initialises the module. | | **Parameters** |
  • deps - The dependencies environment
  • env - The plugin environment
| | **Returns** |
  • Table of the module.
| | **Notes** | None | | **Examples** | None | | **Source** | [src/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 659](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/watchfolders/fcpxml/init.lua#L659) | --- ### [insertFilesIntoFinalCutPro](#insertfilesintofinalcutpro) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `plugins.finalcutpro.watchfolders.fcpxml.insertFilesIntoFinalCutPro(files) -> none` | | **Type** | Function | | **Description** | Imports a file into Final Cut Pro | | **Parameters** |
  • files - File names in table
| | **Returns** |
  • None
| | **Notes** | None | | **Examples** | None | | **Source** | [src/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 295](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/watchfolders/fcpxml/init.lua#L295) | --- ### [newWatcher](#newwatcher) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `plugins.finalcutpro.watchfolders.fcpxml.newWatcher(path) -> none` | | **Type** | Function | | **Description** | New Folder Watcher | | **Parameters** |
  • path - Path to Watch Folder
| | **Returns** |
  • None
| | **Notes** | None | | **Examples** | None | | **Source** | [src/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 532](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/watchfolders/fcpxml/init.lua#L532) | --- ### [refreshTable](#refreshtable) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `plugins.finalcutpro.watchfolders.fcpxml.refreshTable() -> string` | | **Type** | Function | | **Description** | Refreshes the Final Cut Pro Watch Folder Panel via JavaScript Injection | | **Parameters** |
  • None
| | **Returns** |
  • None
| | **Notes** | None | | **Examples** | None | | **Source** | [src/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 145](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/watchfolders/fcpxml/init.lua#L145) | --- ### [removeWatcher](#removewatcher) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `plugins.finalcutpro.watchfolders.fcpxml.removeWatcher(path) -> none` | | **Type** | Function | | **Description** | Remove Folder Watcher | | **Parameters** |
  • path - Path to Watch Folder
| | **Returns** |
  • None
| | **Notes** | None | | **Examples** | None | | **Source** | [src/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 545](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/watchfolders/fcpxml/init.lua#L545) | --- ### [setupWatchers](#setupwatchers) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `plugins.finalcutpro.watchfolders.fcpxml.setupWatchers(path) -> none` | | **Type** | Function | | **Description** | Setup Folder Watchers | | **Parameters** |
  • None
| | **Returns** |
  • None
| | **Notes** | None | | **Examples** | None | | **Source** | [src/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 619](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/watchfolders/fcpxml/init.lua#L619) | --- ### [styleSheet](#stylesheet) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `plugins.finalcutpro.watchfolders.fcpxml.styleSheet() -> cp.web.html` | | **Type** | Function | | **Description** | Generates Style Sheet | | **Parameters** |
  • None
| | **Returns** |
  • Returns Style Sheet as a string
| | **Notes** | None | | **Examples** | None | | **Source** | [src/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 190](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/watchfolders/fcpxml/init.lua#L190) | --- ### [watchFolderTriggered](#watchfoldertriggered) | | | | --------------------------------------------|-------------------------------------------------------------------------------------| | **Signature** | `plugins.finalcutpro.watchfolders.fcpxml.watchFolderTriggered(files) -> none` | | **Type** | Function | | **Description** | Watch Folder Triggered | | **Parameters** |
  • files - A table of files
| | **Returns** |
  • None
| | **Notes** | None | | **Examples** | None | | **Source** | [src/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 436](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/watchfolders/fcpxml/init.lua#L436) | --- ---