# plugins.finalcutpro.timeline.colorboard

Color Board Plugins.

# API Overview

Functions - API calls offered directly by the extension

colorBoardMousePuckRelease
nextAspect
startMousePuck
startShiftingPuck
stopShiftingPuck

# API Documentation

# Functions

# colorBoardMousePuckRelease


Signature	`plugins.finalcutpro.timeline.colorboard.colorBoardMousePuckRelease() -> none`
Type	Function
Description	Color Board Mouse Puck Release
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/timeline/colorboard.lua line 111

# nextAspect


Signature	`plugins.finalcutpro.timeline.colorboard.nextAspect() -> none`
Type	Function
Description	Goes to the next Color Board aspect.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/timeline/colorboard.lua line 127

# startMousePuck


Signature	`plugins.finalcutpro.timeline.colorboard.startMousePuck(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
Notes	None
Examples	None
Source	src/plugins/finalcutpro/timeline/colorboard.lua line 81

# startShiftingPuck


Signature	`plugins.finalcutpro.timeline.colorboard.startShiftingPuck(puck, percentShift, angleShift) -> none`
Type	Function
Description	Starts shifting the puck, repeating at the keyboard repeat rate. Runs until `stopShiftingPuck()` is called.
Parameters	puck - The puck to shift property - The property to shift (typically the `percent` or `angle` value for the puck) amount - The amount to shift the property.
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/timeline/colorboard.lua line 23

# stopShiftingPuck


Signature	`plugins.finalcutpro.timeline.colorboard.stopShiftingPuck() -> none`
Type	Function
Description	Stops the puck from shifting with the keyboard.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/timeline/colorboard.lua line 68