# plugins.core.loupedeckctandlive.prefs

Preferences Panels for Loupedeck CT, Loupedeck Live, Loupedeck Live-S and Razer Stream Controller.

---

## API Overview
**Variables** - _Configurable values_
 * [defaultIconPath](#defaulticonpath)
 * [supportedExtensions](#supportedextensions)

**Functions** - _API calls offered directly by the extension_
 * [buildIconFromLabel](#buildiconfromlabel)
 * [processEncodedIcon](#processencodedicon)
 * [updateUI](#updateui)

**Constructors** - _API calls which return an object, typically one that offers API methods_
 * [new](#new)

**Methods** - _API calls which can only be made on an object returned by a constructor_
 * [generateContent](#generatecontent)
 * [generateKnobImages](#generateknobimages)
 * [panelCallback](#panelcallback)
 * [refreshDevice](#refreshdevice)
 * [renderPanel](#renderpanel)
 * [setItem](#setitem)

---

## API Documentation

#### Variables

### [defaultIconPath](#defaulticonpath)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.core.loupedeckctandlive.prefs.defaultIconPath -> string`                                                                    |
| **Type**                                    | Variable                                                                     |
| **Description**                             | Default Path where built-in icons are stored                                                                     |
| **Notes**                                   | None |
| **Source**                                  | [src/plugins/core/loupedeckctandlive/prefs/init.lua line 90](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/loupedeckctandlive/prefs/init.lua#L90) |

---

### [supportedExtensions](#supportedextensions)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.core.loupedeckctandlive.prefs.supportedExtensions -> string`                                                                    |
| **Type**                                    | Variable                                                                     |
| **Description**                             | Table of supported extensions for Icons.                                                                     |
| **Notes**                                   | None |
| **Source**                                  | [src/plugins/core/loupedeckctandlive/prefs/init.lua line 85](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/loupedeckctandlive/prefs/init.lua#L85) |

---

#### Functions

### [buildIconFromLabel](#buildiconfromlabel)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.core.loupedeckctandlive.prefs:buildIconFromLabel(params) -> string`                                                                    |
| **Type**                                    | Function                                                                     |
| **Description**                             | Creates a new icon image from a string.                                                                     |
| **Parameters**                              | <ul><li>params - A table of parameters.</li></ul> |
| **Returns**                                 | <ul><li>A new encoded icon as URL string.</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/plugins/core/loupedeckctandlive/prefs/init.lua line 1297](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/loupedeckctandlive/prefs/init.lua#L1297) |

---

### [processEncodedIcon](#processencodedicon)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.core.loupedeckctandlive.prefs:processEncodedIcon(icon, controlType) -> string`                                                                    |
| **Type**                                    | Function                                                                     |
| **Description**                             | Processes an encoded icon.                                                                     |
| **Parameters**                              | <ul><li>icon - The encoded icon as URL string or a hs.image object.</li><li>controlType - The control type as string.</li></ul> |
| **Returns**                                 | <ul><li>A new encoded icon as URL string.</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/plugins/core/loupedeckctandlive/prefs/init.lua line 1248](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/loupedeckctandlive/prefs/init.lua#L1248) |

---

### [updateUI](#updateui)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.core.loupedeckctandlive.prefs:updateUI([params]) -> none`                                                                    |
| **Type**                                    | Function                                                                     |
| **Description**                             | Update the Preferences Panel UI.                                                                     |
| **Parameters**                              | <ul><li>params - A optional table of parameters</li></ul> |
| **Returns**                                 | <ul><li>None</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/plugins/core/loupedeckctandlive/prefs/init.lua line 906](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/loupedeckctandlive/prefs/init.lua#L906) |

---

#### Constructors

### [new](#new)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.core.loupedeckctandlive.prefs.new() -> Loupedeck`                                                                    |
| **Type**                                    | Constructor                                                                     |
| **Description**                             | Creates a new Loupedeck Preferences panel.                                                                     |
| **Parameters**                              | <ul><li>deviceType - The device type defined in `hs.loupedeck.deviceTypes`</li></ul> |
| **Returns**                                 | <ul><li>None</li></ul>          |
| **Notes**                                   | <ul><li>The deviceType should be either `hs.loupedeck.deviceTypes.LIVE`</li><li>   or `hs.loupedeck.deviceTypes.CT`.</li></ul> |
| **Examples**                                | None |
| **Source**                                  | [src/plugins/core/loupedeckctandlive/prefs/init.lua line 110](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/loupedeckctandlive/prefs/init.lua#L110) |

---

#### Methods

### [generateContent](#generatecontent)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.core.loupedeckctandlive.prefs:generateContent() -> string`                                                                    |
| **Type**                                    | Method                                                                     |
| **Description**                             | Generates the Preference Panel HTML Content.                                                                     |
| **Parameters**                              | <ul><li>None</li></ul> |
| **Returns**                                 | <ul><li>HTML content as string</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/plugins/core/loupedeckctandlive/prefs/init.lua line 631](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/loupedeckctandlive/prefs/init.lua#L631) |

---

### [generateKnobImages](#generateknobimages)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.core.loupedeckctandlive.prefs:generateKnobImages(app, bank, id) -> none`                                                                    |
| **Type**                                    | Method                                                                     |
| **Description**                             | Generates a combined image for all the knobs on a single side. Which side is generated is determined by the knob id.                                                                     |
| **Parameters**                              | <ul><li>app - The application bundle ID as a string.</li><li>bank - The bank as a string.</li><li>id - The knob ID as a string.</li></ul> |
| **Returns**                                 | <ul><li>None</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/plugins/core/loupedeckctandlive/prefs/init.lua line 734](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/loupedeckctandlive/prefs/init.lua#L734) |

---

### [panelCallback](#panelcallback)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.core.loupedeckctandlive.prefs:panelCallback(id, params) -> none`                                                                    |
| **Type**                                    | Method                                                                     |
| **Description**                             | JavaScript Callback for the Preferences Panel                                                                     |
| **Parameters**                              | <ul><li>id - ID as string</li><li>params - Table of paramaters</li></ul> |
| **Returns**                                 | <ul><li>None</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/plugins/core/loupedeckctandlive/prefs/init.lua line 1384](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/loupedeckctandlive/prefs/init.lua#L1384) |

---

### [refreshDevice](#refreshdevice)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.core.loupedeckctandlive.prefs:refreshDevice() -> none`                                                                    |
| **Type**                                    | Method                                                                     |
| **Description**                             | Refreshes the currently selected Loupedeck Device.                                                                     |
| **Parameters**                              | <ul><li>None</li></ul> |
| **Returns**                                 | <ul><li>None</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/plugins/core/loupedeckctandlive/prefs/init.lua line 1370](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/loupedeckctandlive/prefs/init.lua#L1370) |

---

### [renderPanel](#renderpanel)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.core.loupedeckctandlive.prefs:renderPanel(context) -> none`                                                                    |
| **Type**                                    | Method                                                                     |
| **Description**                             | Generates the Preference Panel HTML Content.                                                                     |
| **Parameters**                              | <ul><li>context - Table of data that you want to share with the renderer</li></ul> |
| **Returns**                                 | <ul><li>HTML content as string</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/plugins/core/loupedeckctandlive/prefs/init.lua line 585](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/loupedeckctandlive/prefs/init.lua#L585) |

---

### [setItem](#setitem)

|                                             |                                                                                     |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature**                               | `plugins.core.loupedeckctandlive.prefs:setItem(app, bank, controlType, id, valueA, valueB) -> none`                                                                    |
| **Type**                                    | Method                                                                     |
| **Description**                             | Update the Loupedeck CT layout file.                                                                     |
| **Parameters**                              | <ul><li>app - The application bundle ID as a string</li><li>bank - The bank ID as a string</li><li>controlType - The control type as a string</li><li>id - The ID of the item as a string</li><li>valueA - The value of the item as a string</li><li>valueB - An optional value</li></ul> |
| **Returns**                                 | <ul><li>None</li></ul>          |
| **Notes**                                   | None |
| **Examples**                                | None |
| **Source**                                  | [src/plugins/core/loupedeckctandlive/prefs/init.lua line 694](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/loupedeckctandlive/prefs/init.lua#L694) |

---

---

<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>