docs » plugins.finalcutpro.clipboard.manager


Clipboard Manager.

API Overview

API Documentation

Variables

excludedClassnames

Signature plugins.finalcutpro.clipboard.manager.excludedClassnames -> table
Type Variable
Description Table of data we don't want to count when copying.

watcherFrequency

Signature plugins.finalcutpro.clipboard.manager.watcherFrequency -> number
Type Variable
Description The Clipboard Watcher Update frequency.

Functions

copyWithCustomClipName

Signature `plugins.finalcutpro.clipboard.manager.copyWithCustomClipName() -> data nil` </span>
Type Function
Description Reads FCPX Data from the Pasteboard as a binary Plist, if present.
Parameters
  • None
Returns
  • The clipboard data or `nil`.

getClassname

Signature plugins.finalcutpro.clipboard.manager.getClassname(data) -> string
Type Function
Description Gets a class anem from data
Parameters
  • data - The data object to process
Returns
  • Class name as string

isClassnameSupported

Signature plugins.finalcutpro.clipboard.manager.isClassnameSupported(classname) -> boolean
Type Function
Description Is the class name supported?
Parameters
  • classname - The class name you want to check
Returns
  • `true` if the class name is supported otherwise `false`.

isTimelineClip

Signature plugins.finalcutpro.clipboard.manager.isTimelineClip(data) -> boolean
Type Function
Description Is the data a timeline clip.
Parameters
  • data - The clipboard data you want to check.
Returns
  • `true` if a timeline clip otherwise `false`.

overrideNextClipName

Signature plugins.finalcutpro.clipboard.manager.overrideNextClipName(overrideName) -> None
Type Function
Description Overrides the name for the next clip which is copied from FCPX to the specified
Parameters
  • overrideName - The override name.
Returns
  • None

processArray

Signature plugins.finalcutpro.clipboard.manager.processArray(data) -> string, number
Type Function
Description Processes an 'array' table.
Parameters
  • data - The data object to process
Returns
  • The primary clip name as a string.
  • The number of clips as number.

processContent

Signature plugins.finalcutpro.clipboard.manager.processContent(fcpxData, default) -> string, number
Type Function
Description Searches the Pasteboard binary plist data for the first clip name, and returns it.
Parameters
  • fcpxData - The data object to process
  • default - The default value
Returns
  • Returns the 'default' value if the pasteboard contains a media clip but we could not interpret it, otherwise `nil` if the data did not contain Final Cut Pro Clip data.
Notes
  • Example usage: `local name = mod.findClipName(myFcpxData, "Unknown")`

processObject

Signature plugins.finalcutpro.clipboard.manager.processObject(data) -> string, number
Type Function
Description Processes the provided data object, which should have a '$class' property.
Parameters
  • data - The clipboard data you want to check.
Returns
  • The primary clip name as a string.
  • The number of clips as number.

startWatching

Signature plugins.finalcutpro.clipboard.manager.startWatching() -> None
Type Function
Description Start Watching the Clipboard.
Parameters
  • None
Returns
  • None

stopWatching

Signature plugins.finalcutpro.clipboard.manager.stopWatching() -> None
Type Function
Description Stop Watching the Clipboard.
Parameters
  • None
Returns
  • None

supportsContainedItems

Signature plugins.finalcutpro.clipboard.manager.supportsContainedItems(data) -> boolean
Type Function
Description Gets whether or not the data supports contained items.
Parameters
  • data - The data object to process
Returns
  • `true` if supported otherwise `false`.

unarchiveFCPXData

Signature `plugins.finalcutpro.clipboard.manager.unarchiveFCPXData(fcpxData) -> data nil` </span>
Type Function
Description Unarchive Final Cut Pro data.
Parameters
  • fcpxData - The data object to process
Returns
  • The unarchived Final Cut Pro Pasteboard data or `nil`.

unwatch

Signature plugins.finalcutpro.clipboard.manager.unwatch(id) -> boolean
Type Function
Description Stop a watcher.
Parameters
  • id - The ID of the watcher you want to stop.
Returns
  • `true` if successful otherwise `false`.

watch

Signature plugins.finalcutpro.clipboard.manager.watch(events) -> table
Type Function
Description Watch events.
Parameters
  • events - Table of events
Returns
  • Table of watchers.

writeFCPXData

Signature plugins.finalcutpro.clipboard.manager.writeFCPXData(fcpxData, quiet) -> boolean
Type Function
Description Write Final Cut Pro data to Pasteboard.
Parameters
  • fcpxData - The data to write
  • quiet - Whether or not we should stop/start the watcher.
Returns
  • `true` if the operation succeeded, otherwise `false` (which most likely means ownership of the pasteboard has changed).

Fields

watching

Signature plugins.finalcutpro.clipboard.manager.watching <cp.prop: boolean>
Type Field
Description Gets whether or not we're watching the clipboard as a boolean.

results matching ""

    No results matching ""