#plugins.finalcutpro.watchfolders.fcpxml

Final Cut Pro FCPXML Watch Folder Plugin.

#API Overview

Constants - Useful values which cannot be changed

Variables - Configurable values

Functions - API calls offered directly by the extension

#API Documentation

#Constants

Signatureplugins.finalcutpro.watchfolders.fcpxml.SECONDS_UNTIL_DELETE -> number
TypeConstant
DescriptionSeconds until a file is deleted.
NotesNone
Sourcesrc/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 31

#Variables

Signatureplugins.finalcutpro.watchfolders.fcpxml.automaticallyImport <cp.prop: boolean>
TypeVariable
DescriptionBoolean that sets whether or not new generated voice file are automatically added to the timeline or not.
NotesNone
Sourcesrc/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 61
Signatureplugins.finalcutpro.watchfolders.fcpxml.deleteAfterImport <cp.prop: boolean>
TypeVariable
DescriptionBoolean that sets whether or not you want to delete file after they've been imported.
NotesNone
Sourcesrc/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 71
Signatureplugins.finalcutpro.watchfolders.fcpxml.disableImport -> boolean
TypeVariable
DescriptionWhen true Notifications will no longer be triggered.
NotesNone
Sourcesrc/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 56
Signatureplugins.finalcutpro.watchfolders.fcpxml.filesInTransit -> table
TypeVariable
DescriptionFiles currently being copied
NotesNone
Sourcesrc/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 41
Signatureplugins.finalcutpro.watchfolders.fcpxml.notifications -> table
TypeVariable
DescriptionTable of Notifications
NotesNone
Sourcesrc/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 51
Signatureplugins.finalcutpro.watchfolders.fcpxml.savedNotifications <cp.prop: table>
TypeVariable
DescriptionTable of Notifications that are saved between restarts
NotesNone
Sourcesrc/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 66
Signatureplugins.finalcutpro.watchfolders.fcpxml.watchFolders <cp.prop: table>
TypeVariable
DescriptionTable of the users watch folders.
NotesNone
Sourcesrc/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 76
Signatureplugins.finalcutpro.watchfolders.fcpxml.watchFolderTableID -> string
TypeVariable
DescriptionWatch Folder Table ID
NotesNone
Sourcesrc/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 36

#Functions

Signatureplugins.finalcutpro.watchfolders.fcpxml.addWatchFolder() -> none
TypeFunction
DescriptionOpens the "Add Watch Folder" Dialog.
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 559
Signatureplugins.finalcutpro.watchfolders.fcpxml.controllerCallback(id, params) -> none
TypeFunction
DescriptionCallback Controller
Parameters
  • id - ID as string
  • params - table of Parameters
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 170
Signatureplugins.finalcutpro.watchfolders.fcpxml.createNotification(file) -> none
TypeFunction
DescriptionCreates a new notification
Parameters
  • file - File name
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 408
Signatureplugins.finalcutpro.watchfolders.fcpxml.generateTable() -> string
TypeFunction
DescriptionGenerate HTML Table
Parameters
  • None
Returns
  • Returns a HTML table as a string
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 81
Signatureplugins.finalcutpro.watchfolders.fcpxml.importFile(file, obj) -> none
TypeFunction
DescriptionImports a file into Final Cut Pro
Parameters
  • file - File name
  • tag - The notification tag
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 337
Signatureplugins.finalcutpro.watchfolders.fcpxml.init(deps, env) -> table
TypeFunction
DescriptionInitialises the module.
Parameters
  • deps - The dependencies environment
  • env - The plugin environment
Returns
  • Table of the module.
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 659
Signatureplugins.finalcutpro.watchfolders.fcpxml.insertFilesIntoFinalCutPro(files) -> none
TypeFunction
DescriptionImports a file into Final Cut Pro
Parameters
  • files - File names in table
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 295
Signatureplugins.finalcutpro.watchfolders.fcpxml.newWatcher(path) -> none
TypeFunction
DescriptionNew Folder Watcher
Parameters
  • path - Path to Watch Folder
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 532
Signatureplugins.finalcutpro.watchfolders.fcpxml.refreshTable() -> string
TypeFunction
DescriptionRefreshes the Final Cut Pro Watch Folder Panel via JavaScript Injection
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 145
Signatureplugins.finalcutpro.watchfolders.fcpxml.removeWatcher(path) -> none
TypeFunction
DescriptionRemove Folder Watcher
Parameters
  • path - Path to Watch Folder
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 545
Signatureplugins.finalcutpro.watchfolders.fcpxml.setupWatchers(path) -> none
TypeFunction
DescriptionSetup Folder Watchers
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 619
Signatureplugins.finalcutpro.watchfolders.fcpxml.styleSheet() -> cp.web.html
TypeFunction
DescriptionGenerates Style Sheet
Parameters
  • None
Returns
  • Returns Style Sheet as a string
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 190
Signatureplugins.finalcutpro.watchfolders.fcpxml.watchFolderTriggered(files) -> none
TypeFunction
DescriptionWatch Folder Triggered
Parameters
  • files - A table of files
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/finalcutpro/watchfolders/fcpxml/init.lua line 436

© Copyright 2025 LateNite Films Pty Ltd. All rights reserved.