manager

Last updated 9 months ago

Pasteboard Manager.

API Overview

API Documentation

Constants

Signature

plugins.finalcutpro.pasteboard.manager.NUMBER_OF_PASTEBOARD_BUFFERS -> number

Type

Constant

Description

Number of Pasteboard Buffers.

Signature

plugins.finalcutpro.pasteboard.manager.RESTART_DELAY -> number

Type

Constant

Description

How long to wait until we restart any Pasteboard Watchers.

Variables

Signature

plugins.finalcutpro.pasteboard.manager.excludedClassnames -> table

Type

Variable

Description

Table of data we don't want to count when copying.

Signature

plugins.finalcutpro.pasteboard.manager.WATCHER_FREQUENCY -> number

Type

Variable

Description

The Pasteboard Watcher Update frequency.

Functions

Signature

plugins.finalcutpro.pasteboard.manager.copyWithCustomClipName() -> none

Type

Function

Description

Copy with custom label.

Parameters

Returns

Signature

plugins.finalcutpro.pasteboard.manager.getClassname(data) -> string

Type

Function

Description

Gets a class anem from data

Parameters

Returns

Signature

plugins.finalcutpro.pasteboard.manager.isClassnameSupported(classname) -> boolean

Type

Function

Description

Is the class name supported?

Parameters

Returns

Signature

plugins.finalcutpro.pasteboard.manager.isTimelineClip(data) -> boolean

Type

Function

Description

Is the data a timeline clip.

Parameters

Returns

Signature

plugins.finalcutpro.pasteboard.manager.overrideNextClipName(overrideName) -> none

Type

Function

Description

Overrides the name for the next clip which is copied from FCPX to the specified

Parameters

Returns

Signature

plugins.finalcutpro.pasteboard.manager.processArray(data) -> string, number

Type

Function

Description

Processes an 'array' table.

Parameters

Returns

Signature

plugins.finalcutpro.pasteboard.manager.processContent(fcpxData, default) -> string, number

Type

Function

Description

Searches the Pasteboard binary plist data for the first clip name, and returns it.

Parameters

Returns

Notes

Signature

plugins.finalcutpro.pasteboard.manager.processObject(data) -> string, number

Type

Function

Description

Processes the provided data object, which should have a '$class' property.

Parameters

Returns

Signature

`plugins.finalcutpro.pasteboard.manager.readFCPXData() -> data

nil` </span>

Type

Function

Description

Reads Final Cut Pro Data from the Pasteboard as a binary Property List, if present.

Parameters

Returns

Signature

plugins.finalcutpro.pasteboard.manager.restoreFromBuffer(id) -> none

Type

Function

Description

Restore a Pasteboard item from the buffer.

Parameters

Returns

Signature

plugins.finalcutpro.pasteboard.manager.saveToBuffer(id) -> none

Type

Function

Description

Save a Pasteboard item to the buffer.

Parameters

Returns

Signature

plugins.finalcutpro.pasteboard.manager.startWatching() -> none

Type

Function

Description

Start Watching the Pasteboard.

Parameters

Returns

Signature

plugins.finalcutpro.pasteboard.manager.stopWatching() -> none

Type

Function

Description

Stop Watching the Pasteboard.

Parameters

Returns

Signature

plugins.finalcutpro.pasteboard.manager.supportsContainedItems(data) -> boolean

Type

Function

Description

Gets whether or not the data supports contained items.

Parameters

Returns

Signature

`plugins.finalcutpro.pasteboard.manager.unarchiveFCPXData(fcpxData) -> data

nil` </span>

Type

Function

Description

Unarchive Final Cut Pro data.

Parameters

Returns

unwatch

Signature

plugins.finalcutpro.pasteboard.manager.unwatch(id) -> boolean

Type

Function

Description

Stop a watcher.

Parameters

Returns

watch

Signature

plugins.finalcutpro.pasteboard.manager.watch(events) -> table

Type

Function

Description

Watch events.

Parameters

Returns

Signature

plugins.finalcutpro.pasteboard.manager.writeFCPXData(fcpxData, quiet) -> boolean

Type

Function

Description

Write Final Cut Pro data to Pasteboard.

Parameters

Returns

Fields

buffer

Signature

plugins.finalcutpro.pasteboard.manager.buffer <cp.prop: table>

Type

Field

Description

Contains the Pasteboard Buffer.

watching

Signature

plugins.finalcutpro.pasteboard.manager.watching <cp.prop: boolean>

Type

Field

Description

Gets whether or not we're watching the pasteboard as a boolean.