# plugins.finalcutpro.watchfolders.fcpxml

Final Cut Pro FCPXML Watch Folder Plugin.

# API Overview

Constants - Useful values which cannot be changed

SECONDS_UNTIL_DELETE

Variables - Configurable values

automaticallyImport
deleteAfterImport
disableImport
filesInTransit
notifications
savedNotifications
watchFolders
watchFolderTableID

Functions - API calls offered directly by the extension

addWatchFolder
controllerCallback
createNotification
generateTable
importFile
init
insertFilesIntoFinalCutPro
newWatcher
refreshTable
removeWatcher
setupWatchers
styleSheet
watchFolderTriggered

# API Documentation

# Constants

# 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

# Variables

# automaticallyImport


Signature	`plugins.finalcutpro.watchfolders.fcpxml.automaticallyImport <cp.prop: boolean>`
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

# deleteAfterImport


Signature	`plugins.finalcutpro.watchfolders.fcpxml.deleteAfterImport <cp.prop: boolean>`
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

# 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

# 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

# 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

# savedNotifications


Signature	`plugins.finalcutpro.watchfolders.fcpxml.savedNotifications <cp.prop: table>`
Type	Variable
Description	Table of Notifications that are saved between restarts
Notes	None
Source	src/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 66

# watchFolders


Signature	`plugins.finalcutpro.watchfolders.fcpxml.watchFolders <cp.prop: table>`
Type	Variable
Description	Table of the users watch folders.
Notes	None
Source	src/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 76

# 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

# Functions

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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