plugins.core.loupedeckctandlive.prefs.md

docs » plugins.core.loupedeckctandlive.prefs

---

Loupedeck CT & Loupedeck Live Preferences Panels

API Overview

• Variables - Configurable values
• defaultIconPath
• supportedExtensions
• Functions - API calls offered directly by the extension
• updateUI
• Constructors - API calls which return an object, typically one that offers API methods
• new
• Methods - API calls which can only be made on an object returned by a constructor
• generateContent
• generateKnobImages
• panelCallback
• renderPanel
• setItem

API Documentation

Variables

defaultIconPath

Signature	plugins.core.loupedeckctandlive.prefs.defaultIconPath -> string
Type	Variable
Description	Default Path where built-in icons are stored

supportedExtensions

Signature	plugins.core.loupedeckctandlive.prefs.supportedExtensions -> string
Type	Variable
Description	Table of supported extensions for Icons.

Functions

updateUI

Signature	plugins.core.loupedeckctandlive.prefs:updateUI([params]) -> none
Type	Function
Description	Update the Preferences Panel UI.
Parameters	params - A optional table of parameters
Returns	None

Constructors

new

Signature	plugins.core.loupedeckctandlive.prefs.new() -> Loupedeck
Type	Constructor
Description	Creates a new Loupedeck Preferences panel.
Parameters	deviceType - The device type defined in hs.loupedeck.deviceTypes
Returns	None
Notes	The deviceType should be either hs.loupedeck.deviceTypes.LIVE or hs.loupedeck.deviceTypes.CT.

Methods

generateContent

Signature	plugins.core.loupedeckctandlive.prefs:generateContent() -> string
Type	Method
Description	Generates the Preference Panel HTML Content.
Parameters	None
Returns	HTML content as string

generateKnobImages

Signature	plugins.core.loupedeckctandlive.prefs:generateKnobImages(app, bank, id) -> none
Type	Method
Description	Generates a combined image for all the knobs.
Parameters	app - The application bundle ID bank - The bank as a string id - The ID
Returns	None

panelCallback

Signature	plugins.core.loupedeckctandlive.prefs:panelCallback() -> none
Type	Method
Description	JavaScript Callback for the Preferences Panel
Parameters	id - ID as string params - Table of paramaters
Returns	None

renderPanel

Signature	plugins.core.loupedeckctandlive.prefs:renderPanel(context) -> none
Type	Method
Description	Generates the Preference Panel HTML Content.
Parameters	context - Table of data that you want to share with the renderer
Returns	HTML content as string

setItem

Signature	plugins.core.loupedeckctandlive.prefs:setItem(app, bank, controlType, id, valueA, valueB) -> none
Type	Method
Description	Update the Loupedeck CT layout file.
Parameters	app - The application bundle ID as a string bank - The bank ID as a string controlType - The control type as a string id - The ID of the item as a string valueA - The value of the item as a string valueB - An optional value
Returns	None