#plugins.finalcutpro.touchbar.widgets.colorboard

A collection of Final Cut Pro Color Board Widgets for the Touch Bar.

#API Overview

Variables - Configurable values

active
hasWidgets
updateInterval

Functions - API calls offered directly by the extension

init
start
stop

#API Documentation

#Variables

#active


Signature	`plugins.finalcutpro.touchbar.widgets.colorboard.active <cp.prop: boolean>`
Type	Variable
Description	Indicates if the widget is active.
Notes	None
Source	src/plugins/finalcutpro/touchbar/widgets/colorboard.lua line 678

#hasWidgets


Signature	`plugins.finalcutpro.touchbar.widgets.colorboard.hasWidgets <cp.prop: boolean>`
Type	Variable
Description	Indicates if any widgests have been created.
Notes	None
Source	src/plugins/finalcutpro/touchbar/widgets/colorboard.lua line 673

#updateInterval


Signature	`plugins.finalcutpro.touchbar.widgets.colorboard.updateInterval -> number`
Type	Variable
Description	How often the Touch Bar widgets should be refreshed in seconds
Notes	None
Source	src/plugins/finalcutpro/touchbar/widgets/colorboard.lua line 24

#Functions

#init


Signature	`plugins.finalcutpro.touchbar.widgets.colorboard.init() -> nil`
Type	Function
Description	Initialise the module.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/touchbar/widgets/colorboard.lua line 503

#start


Signature	`plugins.finalcutpro.touchbar.widgets.colorboard.start() -> nil`
Type	Function
Description	Stops the Timer.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/touchbar/widgets/colorboard.lua line 179

#stop


Signature	`plugins.finalcutpro.touchbar.widgets.colorboard.stop() -> nil`
Type	Function
Description	Stops the Timer.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/touchbar/widgets/colorboard.lua line 205