plugins.finalcutpro.touchbar.widgets.colorboard.md

docs » 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.

hasWidgets

Signature	plugins.finalcutpro.touchbar.widgets.colorboard.hasWidgets <cp.prop: boolean>
Type	Variable
Description	Indicates if any widgests have been created.

updateInterval

Signature	plugins.finalcutpro.touchbar.widgets.colorboard.updateInterval -> number
Type	Variable
Description	How often the Touch Bar widgets should be refreshed in seconds

Functions

init

Signature	plugins.finalcutpro.touchbar.widgets.colorboard.init() -> nil
Type	Function
Description	Initialise the module.
Parameters	None
Returns	None

start

Signature	plugins.finalcutpro.touchbar.widgets.colorboard.start() -> nil
Type	Function
Description	Stops the Timer.
Parameters	None
Returns	None

stop

Signature	plugins.finalcutpro.touchbar.widgets.colorboard.stop() -> nil
Type	Function
Description	Stops the Timer.
Parameters	None
Returns	None