plugins.finalcutpro.pasteboard.shared.md

docs » plugins.finalcutpro.pasteboard.shared

---

Shared Pasteboard Plugin.

API Overview

• Functions - API calls offered directly by the extension
• copyWithCustomClipName
• copyWithCustomClipNameAndFolder
• doDecodeHistoryItem
• doPasteHistoryItem
• generateSharedPasteboardMenu
• getFolderNames
• getHistory
• getHistoryPath
• getLocalFolderName
• getRootPath
• overrideNextFolderName
• setHistory
• setRootPath
• update
• validRootPath
• Fields - Variables which can only be accessed from an object returned by a constructor
• enabled

API Documentation

Functions

copyWithCustomClipName

Signature	plugins.finalcutpro.pasteboard.shared.copyWithCustomClipName() -> None
Type	Function
Description	Triggers a copy with custom clip name action.
Parameters	None
Returns	None

copyWithCustomClipNameAndFolder

Signature	plugins.finalcutpro.pasteboard.shared.copyWithCustomClipNameAndFolder() -> none
Type	Function
Description	Copy with Custom Label & Folder.
Parameters	None
Returns	None

doDecodeHistoryItem

| Signature | plugins.finalcutpro.pasteboard.shared.doDecodeHistoryItem(folderName, index) -> string | nil | | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Function | | Description | Decodes a Paste History Item. | | Parameters |

• folderName - The folder name
• index - The index of the item you want to decode

| | Returns |

• The decoded Pasteboard History Item or nil.

|

doPasteHistoryItem

Signature	plugins.finalcutpro.pasteboard.shared.doPasteHistoryItem(folderName, index) -> none
Type	Function
Description	Paste History Item.
Parameters	folderName - The folder name index - The index of the item you want to paste
Returns	None

generateSharedPasteboardMenu

Signature	plugins.finalcutpro.pasteboard.shared.generateSharedPasteboardMenu() -> table
Type	Function
Description	Generates the shared pasteboard menu.
Parameters	None
Returns	The shared pasteboard menu as a table.

getFolderNames

Signature	plugins.finalcutpro.pasteboard.shared.getFolderNames() -> table
Type	Function
Description	Returns the list of folder names as an array of strings.
Parameters	None
Returns	A table of folder names.

getHistory

Signature	plugins.finalcutpro.pasteboard.shared.getHistory(folderName) -> table
Type	Function
Description	Gets the history for a supplied folder name.
Parameters	folderName - The folder name
Returns	The history in a table.

getHistoryPath

Signature	plugins.finalcutpro.pasteboard.shared.getHistoryPath(folderName, fileExtension) -> string
Type	Function
Description	Gets the History Path.
Parameters	folderName - The folder name fileExtension - The file extension
Returns	The history path as a string

getLocalFolderName

Signature	plugins.finalcutpro.pasteboard.shared.getLocalFolderName() -> string
Type	Function
Description	Gets the local folder name.
Parameters	None
Returns	The local folder name as a string.

getRootPath

Signature	plugins.finalcutpro.pasteboard.shared.getRootPath() -> string
Type	Function
Description	Get shared pasteboard root path.
Parameters	None
Returns	Shared Pasteboard Path as string.

overrideNextFolderName

Signature	plugins.finalcutpro.pasteboard.shared.overrideNextFolderName(overrideFolder) -> none
Type	Function
Description	Overrides the folder name for the next clip which is copied from Final Cut Pro to the
Parameters	None
Returns	The local folder name as a string.

setHistory

Signature	plugins.finalcutpro.pasteboard.shared.setHistory(folderName, history) -> none
Type	Function
Description	Clears the history.
Parameters	folderName - The folder name
Returns	None

setRootPath

Signature	plugins.finalcutpro.pasteboard.shared.setRootPath(path) -> none
Type	Function
Description	Sets the shared pasteboard root path.
Parameters	path - The path you want to set as a string.
Returns	None

update

Signature	plugins.finalcutpro.pasteboard.shared.update() -> none
Type	Function
Description	Starts or stops the Shared Pasteboard watcher.
Parameters	None
Returns	None

validRootPath

Signature	plugins.finalcutpro.pasteboard.shared.validRootPath() -> boolean
Type	Function
Description	Gets whether or not the current root path exists.
Parameters	None
Returns	true if it exists otherwise false.

Fields

enabled

Signature	plugins.finalcutpro.pasteboard.shared.enabled <cp.prop: boolean>
Type	Field
Description	Gets whether or not the shared pasteboard is enabled as a boolean.