plugins.finalcutpro.watchfolders.fcpxml.md

docs » 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.

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.

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.

disableImport

Signature	plugins.finalcutpro.watchfolders.fcpxml.disableImport -> boolean
Type	Variable
Description	When true Notifications will no longer be triggered.

filesInTransit

Signature	plugins.finalcutpro.watchfolders.fcpxml.filesInTransit -> table
Type	Variable
Description	Files currently being copied

notifications

Signature	plugins.finalcutpro.watchfolders.fcpxml.notifications -> table
Type	Variable
Description	Table of Notifications

savedNotifications

Signature	plugins.finalcutpro.watchfolders.fcpxml.savedNotifications <cp.prop: table>
Type	Variable
Description	Table of Notifications that are saved between restarts

watchFolders

Signature	plugins.finalcutpro.watchfolders.fcpxml.watchFolders <cp.prop: table>
Type	Variable
Description	Table of the users watch folders.

watchFolderTableID

Signature	plugins.finalcutpro.watchfolders.fcpxml.watchFolderTableID -> string
Type	Variable
Description	Watch Folder Table ID

Functions

addWatchFolder

Signature	plugins.finalcutpro.watchfolders.fcpxml.addWatchFolder() -> none
Type	Function
Description	Opens the "Add Watch Folder" Dialog.
Parameters	None
Returns	None

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

createNotification

Signature	plugins.finalcutpro.watchfolders.fcpxml.createNotification(file) -> none
Type	Function
Description	Creates a new notification
Parameters	file - File name
Returns	None

generateTable

Signature	plugins.finalcutpro.watchfolders.fcpxml.generateTable() -> string
Type	Function
Description	Generate HTML Table
Parameters	None
Returns	Returns a HTML table as a string

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

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.

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

newWatcher

Signature	plugins.finalcutpro.watchfolders.fcpxml.newWatcher(path) -> none
Type	Function
Description	New Folder Watcher
Parameters	path - Path to Watch Folder
Returns	None

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

removeWatcher

Signature	plugins.finalcutpro.watchfolders.fcpxml.removeWatcher(path) -> none
Type	Function
Description	Remove Folder Watcher
Parameters	path - Path to Watch Folder
Returns	None

setupWatchers

Signature	plugins.finalcutpro.watchfolders.fcpxml.setupWatchers(path) -> none
Type	Function
Description	Setup Folder Watchers
Parameters	None
Returns	None

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

watchFolderTriggered

Signature	plugins.finalcutpro.watchfolders.fcpxml.watchFolderTriggered(files) -> none
Type	Function
Description	Watch Folder Triggered
Parameters	files - A table of files
Returns	None