plugins.finalcutpro.timeline.colorboard.md

docs » plugins.finalcutpro.timeline.colorboard

---

Color Board Plugins.

API Overview

• Functions - API calls offered directly by the extension
• colorBoardMousePuckRelease
• colorBoardSelectPuckRelease
• mousePuck
• selectPuck

API Documentation

Functions

colorBoardMousePuckRelease

Signature	plugins.finalcutpro.timeline.colorboard.colorBoardMousePuckRelease() -> none
Type	Function
Description	Color Board Mouse Puck Release
Parameters	None
Returns	None

colorBoardSelectPuckRelease

Signature	plugins.finalcutpro.timeline.colorboard.colorBoardSelectPuckRelease() -> none
Type	Function
Description	Color Board Release Keypress
Parameters	None
Returns	None

mousePuck

Signature	plugins.finalcutpro.timeline.colorboard.mousePuck(aspect, property) -> none
Type	Function
Description	Color Board - Puck Control Via Mouse
Parameters	aspect - "global", "shadows", "midtones" or "highlights" property - "Color", "Saturation" or "Exposure"
Returns	None

selectPuck

Signature	plugins.finalcutpro.timeline.colorboard.selectPuck(aspect, property, whichDirection) -> none
Type	Function
Description	Color Board - Select Puck
Parameters	aspect - "global", "shadows", "midtones" or "highlights" property - "Color", "Saturation" or "Exposure" whichDirection - "up" or "down"
Returns	None