shared

Last updated 3 months ago

Shared Pasteboard Plugin.

API Overview

API Documentation

Functions

Signature

plugins.finalcutpro.pasteboard.shared.copyWithCustomClipName() -> None

Type

Function

Description

Triggers a copy with custom clip name action.

Parameters

Returns

Signature

plugins.finalcutpro.pasteboard.shared.copyWithCustomClipNameAndFolder() -> none

Type

Function

Description

Copy with Custom Label & Folder.

Parameters

Returns

Signature

plugins.finalcutpro.pasteboard.shared.generateSharedPasteboardMenu() -> table

Type

Function

Description

Generates the shared pasteboard menu.

Parameters

Returns

Signature

plugins.finalcutpro.pasteboard.shared.getHistory(folderName) -> table

Type

Function

Description

Gets the history for a supplied folder name.

Parameters

Returns

Signature

plugins.finalcutpro.pasteboard.shared.getHistoryPath(folderName, fileExtension) -> string

Type

Function

Description

Gets the History Path.

Parameters

Returns

Signature

plugins.finalcutpro.pasteboard.shared.getLocalFolderName() -> string

Type

Function

Description

Gets the local folder name.

Parameters

Returns

Signature

plugins.finalcutpro.pasteboard.shared.getRootPath() -> string

Type

Function

Description

Get shared pasteboard root path.

Parameters

Returns

init

Signature

plugins.finalcutpro.pasteboard.shared.init() -> sharedPasteboard

Type

Function

Description

Initialises the module.

Parameters

Returns

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

Returns

Signature

plugins.finalcutpro.pasteboard.shared.pasteHistoryItem(folderName, index) -> none

Type

Function

Description

Paste History Item.

Parameters

Returns

Signature

plugins.finalcutpro.pasteboard.shared.setHistory(folderName, history) -> none

Type

Function

Description

Clears the history.

Parameters

Returns

Signature

plugins.finalcutpro.pasteboard.shared.setRootPath(path) -> none

Type

Function

Description

Sets the shared pasteboard root path.

Parameters

Returns

update

Signature

plugins.finalcutpro.pasteboard.shared.update() -> table

Type

Function

Description

Returns the list of folder names as an array of strings.

Parameters

Returns

Signature

plugins.finalcutpro.pasteboard.shared.validRootPath() -> boolean

Type

Function

Description

Gets whether or not the current root path exists.

Parameters

Returns

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.