docs » plugins.finalcutpro.watchfolders.panels.media


Final Cut Pro Media Watch Folder Plugin.

API Overview

API Documentation

Variables

audioTag

Signature plugins.finalcutpro.watchfolders.panels.media.audioTag
Type Variable
Description String which contains the audio tag.

automaticallyImport

Signature plugins.finalcutpro.watchfolders.panels.media.automaticallyImport
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.panels.media.deleteAfterImport
Type Variable
Description Boolean that sets whether or not you want to delete file after they've been imported.

disableImport

Signature plugins.finalcutpro.watchfolders.panels.media.disableImport
Type Variable
Description When true Notifications will no longer be triggered.

filesInTransit

Signature plugins.finalcutpro.watchfolders.panels.media.filesInTransit
Type Variable
Description Files currently being copied

imageTag

Signature plugins.finalcutpro.watchfolders.panels.media.imageTag
Type Variable
Description String which contains the stills tag.

insertIntoTimeline

Signature plugins.finalcutpro.watchfolders.panels.media.insertIntoTimeline
Type Variable
Description Boolean that sets whether or not the files are automatically added to the timeline or not.

notifications

Signature plugins.finalcutpro.watchfolders.panels.media.notifications
Type Variable
Description Table of Notifications

savedNotifications

Signature plugins.finalcutpro.watchfolders.panels.media.savedNotifications
Type Variable
Description Table of Notifications that are saved between restarts

videoTag

Signature plugins.finalcutpro.watchfolders.panels.media.videoTag
Type Variable
Description String which contains the video tag.

watchFolders

Signature plugins.finalcutpro.watchfolders.panels.media.watchFolders
Type Variable
Description Table of the users watch folders.

watchFolderTableID

Signature plugins.finalcutpro.watchfolders.panels.media.watchFolderTableID
Type Variable
Description Watch Folder Table ID

Functions

addWatchFolder

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

controllerCallback

Signature plugins.finalcutpro.watchfolders.panels.media.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.panels.media.createNotification(file) -> none
Type Function
Description Creates a new notification
Parameters
  • file - File name
Returns
  • None

generateTable

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

importFile

Signature plugins.finalcutpro.watchfolders.panels.media.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.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.

insertFilesIntoFinalCutPro

Signature plugins.finalcutpro.watchfolders.panels.media.insertFilesIntoFinalCutPro(files) -> none
Type Function
Description Imports a file into Final Cut Pro
Parameters
  • file - File name
  • tag - The notification tag
Returns
  • None

newWatcher

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

refreshTable

Signature plugins.finalcutpro.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.finalcutpro.watchfolders.panels.media.removeWatcher(path) -> none
Type Function
Description Remove Folder Watcher
Parameters
  • path - Path to Watch Folder
Returns
  • None

setupWatchers

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

styleSheet

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

watchFolderTriggered

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

results matching ""

    No results matching ""