# plugins.finalcutpro.touchbar.widgets.colorboard

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

---

## API Overview
**Variables** - _Configurable values_
 * [active](#active)
 * [hasWidgets](#haswidgets)
 * [updateInterval](#updateinterval)

**Functions** - _API calls offered directly by the extension_
 * [init](#init)
 * [start](#start)
 * [stop](#stop)

---

## API Documentation

#### Variables

### [active](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/touchbar/widgets/colorboard.lua#L678) |

---

### [hasWidgets](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/touchbar/widgets/colorboard.lua#L673) |

---

### [updateInterval](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/touchbar/widgets/colorboard.lua#L24) |

---

#### Functions

### [init](#init)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.touchbar.widgets.colorboard.init() -> nil`                                                                    |
| **Type**                                    | Function                                                                     |
| **Description**                             | Initialise the module.                                                                     |
| **Parameters**                              | <ul><li>None</li></ul> |
| **Returns**                                 | <ul><li>None</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/plugins/finalcutpro/touchbar/widgets/colorboard.lua line 503](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/touchbar/widgets/colorboard.lua#L503) |

---

### [start](#start)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.touchbar.widgets.colorboard.start() -> nil`                                                                    |
| **Type**                                    | Function                                                                     |
| **Description**                             | Stops the Timer.                                                                     |
| **Parameters**                              | <ul><li>None</li></ul> |
| **Returns**                                 | <ul><li>None</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/plugins/finalcutpro/touchbar/widgets/colorboard.lua line 179](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/touchbar/widgets/colorboard.lua#L179) |

---

### [stop](#stop)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.finalcutpro.touchbar.widgets.colorboard.stop() -> nil`                                                                    |
| **Type**                                    | Function                                                                     |
| **Description**                             | Stops the Timer.                                                                     |
| **Parameters**                              | <ul><li>None</li></ul> |
| **Returns**                                 | <ul><li>None</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/plugins/finalcutpro/touchbar/widgets/colorboard.lua line 205](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/finalcutpro/touchbar/widgets/colorboard.lua#L205) |

---

---

<script src="https://giscus.app/client.js"
        data-repo="CommandPost/CommandPost"
        data-repo-id="MDEwOlJlcG9zaXRvcnk3NDY0NTk2NQ=="
        data-category="Website Discussion"
        data-category-id="DIC_kwDOBHMBzc4CXFFA"
        data-mapping="pathname"
        data-strict="0"
        data-reactions-enabled="1"
        data-emit-metadata="0"
        data-input-position="bottom"
        data-theme="dark"
        data-lang="en"
        crossorigin="anonymous"
        async>
</script>