plugins.compressor.watchfolders.panels.media.md

docs » plugins.compressor.watchfolders.panels.media

---

Compressor Watch Folder Plugin.

API Overview

• Variables - Configurable values
• disableImport
• filesInTransit
• notifications
• savedNotifications
• tasks
• watchFolders
• Functions - API calls offered directly by the extension
• addFilesToCompressor
• addWatchFolder
• controllerCallback
• generateTable
• init
• newWatcher
• refreshTable
• removeWatcher
• setupWatchers
• styleSheet
• watchCompressorStatus
• watchFolderTriggered

API Documentation

Variables

disableImport

Signature	plugins.compressor.watchfolders.panels.media.disableImport -> boolean
Type	Variable
Description	When true Notifications will no longer be triggered.

filesInTransit

Signature	plugins.compressor.watchfolders.panels.media.filesInTransit -> table
Type	Variable
Description	Files currently being copied

notifications

Signature	plugins.compressor.watchfolders.panels.media.notifications -> table
Type	Variable
Description	Table of Notifications

savedNotifications

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

tasks

Signature	plugins.compressor.watchfolders.panels.media.tasks -> table
Type	Variable
Description	Table of Tasks

watchFolders

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

Functions

addFilesToCompressor

Signature	plugins.compressor.watchfolders.panels.media.addFilesToCompressor(files) -> none
Type	Function
Description	Imports a file into Final Cut Pro
Parameters	files - File names in table
Returns	None

addWatchFolder

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

controllerCallback

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

generateTable

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

init

Signature	plugins.compressor.watchfolders.panels.media.init(deps, env) -> table
Type	Function
Description	Initialises the module.
Parameters	deps - The dependencies environment env - The plugin environment
Returns	Table of the module.

newWatcher

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

refreshTable

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

removeWatcher

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

setupWatchers

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

styleSheet

Signature	plugins.compressor.watchfolders.panels.media.styleSheet() -> cp.web.html
Type	Function
Description	Generates Style Sheet
Parameters	None
Returns	Returns Style Sheet as a cp.web.html block.

watchCompressorStatus

Signature	plugins.compressor.watchfolders.panels.media.watchCompressorStatus(jobID) -> none
Type	Function
Description	Checks the Status of a Job in Compressor
Parameters	jobID - Job ID as string file - File Path as string destinationPath - Destination Path as string
Returns	None

watchFolderTriggered

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