fcpxml

Last updated 2 months ago

Final Cut Pro FCPXML Watch Folder Plugin.

API Overview

API Documentation

Constants

Signature

plugins.finalcutpro.watchfolders.panels.fcpxml.SECONDS_UNTIL_DELETE -> number

Type

Constant

Description

Seconds until a file is deleted.

Variables

Signature

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

Signature

plugins.finalcutpro.watchfolders.panels.fcpxml.deleteAfterImport <cp.prop: boolean>

Type

Variable

Description

Boolean that sets whether or not you want to delete file after they've been imported.

Signature

plugins.finalcutpro.watchfolders.panels.fcpxml.disableImport -> boolean

Type

Variable

Description

When true Notifications will no longer be triggered.

Signature

plugins.finalcutpro.watchfolders.panels.fcpxml.filesInTransit -> table

Type

Variable

Description

Files currently being copied

Signature

plugins.finalcutpro.watchfolders.panels.fcpxml.notifications -> table

Type

Variable

Description

Table of Notifications

Signature

plugins.finalcutpro.watchfolders.panels.fcpxml.savedNotifications <cp.prop: table>

Type

Variable

Description

Table of Notifications that are saved between restarts

Signature

plugins.finalcutpro.watchfolders.panels.fcpxml.watchFolders <cp.prop: table>

Type

Variable

Description

Table of the users watch folders.

Signature

plugins.finalcutpro.watchfolders.panels.fcpxml.watchFolderTableID -> string

Type

Variable

Description

Watch Folder Table ID

Functions

Signature

plugins.finalcutpro.watchfolders.panels.fcpxml.addWatchFolder() -> none

Type

Function

Description

Opens the "Add Watch Folder" Dialog.

Parameters

Returns

Signature

plugins.finalcutpro.watchfolders.panels.fcpxml.controllerCallback(id, params) -> none

Type

Function

Description

Callback Controller

Parameters

Returns

Signature

plugins.finalcutpro.watchfolders.panels.fcpxml.createNotification(file) -> none

Type

Function

Description

Creates a new notification

Parameters

Returns

Signature

plugins.finalcutpro.watchfolders.panels.fcpxml.generateTable() -> string

Type

Function

Description

Generate HTML Table

Parameters

Returns

Signature

plugins.finalcutpro.watchfolders.panels.fcpxml.importFile(file, obj) -> none

Type

Function

Description

Imports a file into Final Cut Pro

Parameters

Returns

init

Signature

plugins.finalcutpro.watchfolders.panels.fcpxml.init(deps, env) -> table

Type

Function

Description

Initialises the module.

Parameters

Returns

Signature

plugins.finalcutpro.watchfolders.panels.fcpxml.insertFilesIntoFinalCutPro(files) -> none

Type

Function

Description

Imports a file into Final Cut Pro

Parameters

Returns

Signature

plugins.finalcutpro.watchfolders.panels.fcpxml.newWatcher(path) -> none

Type

Function

Description

New Folder Watcher

Parameters

Returns

Signature

plugins.finalcutpro.watchfolders.panels.fcpxml.refreshTable() -> string

Type

Function

Description

Refreshes the Final Cut Pro Watch Folder Panel via JavaScript Injection

Parameters

Returns

Signature

plugins.finalcutpro.watchfolders.panels.fcpxml.removeWatcher(path) -> none

Type

Function

Description

Remove Folder Watcher

Parameters

Returns

Signature

plugins.finalcutpro.watchfolders.panels.fcpxml.setupWatchers(path) -> none

Type

Function

Description

Setup Folder Watchers

Parameters

Returns

Signature

plugins.finalcutpro.watchfolders.panels.fcpxml.styleSheet() -> cp.web.html

Type

Function

Description

Generates Style Sheet

Parameters

Returns

Signature

plugins.finalcutpro.watchfolders.panels.fcpxml.watchFolderTriggered(files) -> none

Type

Function

Description

Watch Folder Triggered

Parameters

Returns