media

Last updated 2 months ago

Final Cut Pro Media Watch Folder Plugin.

Submodules

API Overview

API Documentation

Constants

Signature

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

Type

Constant

Description

Seconds until a file is deleted.

Variables

Signature

plugins.finalcutpro.watchfolders.panels.media.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.media.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.media.insertIntoTimeline <cp.prop: boolean>

Type

Variable

Description

Boolean that sets whether or not the files are automatically added to the timeline or not.

Signature

plugins.finalcutpro.watchfolders.panels.media.mediaFolders

Type

Variable

Description

The table of MediaFolders currently configured.

Signature

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

Type

Variable

Description

Watch Folder Table ID

Functions

Signature

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

Type

Function

Description

Opens the "Add Watch Folder" Dialog.

Parameters

None

Returns

None

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

Signature

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

Type

Function

Description

Generate HTML Table

Parameters

None

Returns

Returns a HTML table as a string

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.

Signature

plugins.finalcutpro.watchfolders.panels.media.loadMediaFolders()

Type

Function

Description

Loads the MediaFolder list from storage. Any existing MediaFolder instances

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

Signature

plugins.finalcutpro.watchfolders.panels.media.saveMediaFolders()

Type

Function

Description

Saves the current state of the media folders, including notifications, etc.

Parameters

None

Returns

Nothing

Signature

plugins.finalcutpro.watchfolders.panels.media.styleSheet() -> string

Type

Function

Description

Generates Style Sheet

Parameters

None

Returns

Returns Style Sheet as a string