plugins.finalcutpro.watchfolders.media.md

docs » plugins.finalcutpro.watchfolders.media

---

Final Cut Pro Media Watch Folder Plugin.

Submodules

• plugins.finalcutpro.watchfolders.media.MediaFolder
• plugins.finalcutpro.watchfolders.media.panel

API Overview

• Constants - Useful values which cannot be changed
• SECONDS_UNTIL_DELETE
• Variables - Configurable values
• automaticallyImport
• deleteAfterImport
• insertIntoTimeline
• mediaFolders
• Functions - API calls offered directly by the extension
• init
• loadMediaFolders
• saveMediaFolders

API Documentation

Constants

SECONDS_UNTIL_DELETE

Signature	plugins.finalcutpro.watchfolders.media.SECONDS_UNTIL_DELETE -> number
Type	Constant
Description	Seconds until a file is deleted.

Variables

automaticallyImport

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

deleteAfterImport

Signature	plugins.finalcutpro.watchfolders.media.deleteAfterImport <cp.prop: boolean>
Type	Variable
Description	Boolean that sets whether or not you want to delete file after they've been imported.

insertIntoTimeline

Signature	plugins.finalcutpro.watchfolders.media.insertIntoTimeline <cp.prop: boolean>
Type	Variable
Description	Boolean that sets whether or not the files are automatically added to the timeline or not.

mediaFolders

Signature	plugins.finalcutpro.watchfolders.media.mediaFolders -> table
Type	Variable
Description	The table of MediaFolders currently configured.

Functions

init

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

loadMediaFolders

Signature	plugins.finalcutpro.watchfolders.media.loadMediaFolders()
Type	Function
Description	Loads the MediaFolder list from storage. Any existing MediaFolder instances

saveMediaFolders

Signature	plugins.finalcutpro.watchfolders.media.saveMediaFolders()
Type	Function
Description	Saves the current state of the media folders, including notifications, etc.
Parameters	None
Returns	Nothing