#plugins.finalcutpro.watchfolders.media

Final Cut Pro Media Watch Folder Plugin.

#Submodules

#API Overview

Constants - Useful values which cannot be changed

SECONDS_UNTIL_DELETE

Variables - Configurable values

automaticallyImport
deleteAfterImport
insertIntoTimeline

Functions - API calls offered directly by the extension

addMediaFolder
hasMediaFolder
init
loadMediaFolders
mediaFolders
removeMediaFolder
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.
Notes	None
Source	src/plugins/finalcutpro/watchfolders/media/init.lua line 135

#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.
Notes	None
Source	src/plugins/finalcutpro/watchfolders/media/init.lua line 140

#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.
Notes	None
Source	src/plugins/finalcutpro/watchfolders/media/init.lua line 150

#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.
Notes	None
Source	src/plugins/finalcutpro/watchfolders/media/init.lua line 145

#Functions

#addMediaFolder


Signature	`plugins.finalcutpro.watchfolders.media.addMediaFolder(path, videoTag, audioTag, imageTag) -> none`
Type	Function
Description	Removes a media folder.
Parameters	path - The path of the folder to remove. videoTag - An optional video tag as a string. audioTag - An optional audio tag as a string. imageTag - An optional image tag as a string.
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/watchfolders/media/init.lua line 27

#hasMediaFolder


Signature	`plugins.finalcutpro.watchfolders.media.hasMediaFolder(path) -> boolean`
Type	Function
Description	Checks to see if a path has a media folder already saved.
Parameters	path - The path to check.
Returns	A boolean
Notes	None
Examples	None
Source	src/plugins/finalcutpro/watchfolders/media/init.lua line 64

#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.
Notes	None
Examples	None
Source	src/plugins/finalcutpro/watchfolders/media/init.lua line 155

#loadMediaFolders


Signature	`plugins.finalcutpro.watchfolders.media.loadMediaFolders() -> none`
Type	Function
Description	Loads the MediaFolder list from storage. Any existing MediaFolder instances will be destroyed before loading.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/watchfolders/media/init.lua line 111

#mediaFolders


Signature	`plugins.finalcutpro.watchfolders.media.mediaFolders() -> table`
Type	Function
Description	Gets a table of all the media folders.
Parameters	None
Returns	A table of all the media folders.
Notes	None
Examples	None
Source	src/plugins/finalcutpro/watchfolders/media/init.lua line 81

#removeMediaFolder


Signature	`plugins.finalcutpro.watchfolders.media.removeMediaFolder(path) -> boolean`
Type	Function
Description	Removes a media folder.
Parameters	path - The path of the folder to remove.
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/watchfolders/media/init.lua line 44

#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
Notes	None
Examples	None
Source	src/plugins/finalcutpro/watchfolders/media/init.lua line 94