plugins.finalcutpro.watchfolders.media.panel.md

docs » plugins.finalcutpro.watchfolders.media.panel

---

Watch Folder Media Panel.

API Overview

• Variables - Configurable values
• watchFolderTableID
• Functions - API calls offered directly by the extension
• addWatchFolder
• controllerCallback
• generateTable
• init
• refreshTable
• styleSheet

API Documentation

Variables

watchFolderTableID

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

Functions

addWatchFolder

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

controllerCallback

Signature	plugins.finalcutpro.watchfolders.media.panel.controllerCallback(id, params) -> none
Type	Function
Description	Callback Controller
Parameters	id - ID as string params - table of Parameters
Returns	None

generateTable

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

init

Signature	plugins.finalcutpro.watchfolders.media.panel.init(mediaFolderManager, panelManager) -> self
Type	Function
Description	Initialises the module.
Parameters	mediaFolderManager - Media Folder Manager panelManager - Panel Manager
Returns	Self

refreshTable

Signature	plugins.finalcutpro.watchfolders.media.panel.refreshTable() -> string
Type	Function
Description	Refreshes the Final Cut Pro Watch Folder Panel via JavaScript Injection
Parameters	None
Returns	None

styleSheet

Signature	plugins.finalcutpro.watchfolders.media.panel.styleSheet() -> string
Type	Function
Description	Generates Style Sheet
Parameters	None
Returns	Returns Style Sheet as a string