plugins.core.loupedeckctandlive.manager.md

docs » plugins.core.loupedeckctandlive.manager

---

Loupedeck CT & Loupedeck Live Manager Plugin.

API Overview

• 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
• callback
• clearCache
• getFlashDrivePath
• refresh
• refreshItems
• reset

API Documentation

Constructors

new

Signature	plugins.core.loupedeckctandlive.manager.new() -> Loupedeck
Type	Constructor
Description	Creates a new Loupedeck object.
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

callback

Signature	plugins.core.loupedeckctandlive.manager:callback(data) -> none
Type	Method
Description	The Loupedeck callback.
Parameters	data - The callback data.
Returns	None

clearCache

Signature	plugins.core.loupedeckctandlive.manager:clearCache() -> none
Type	Method
Description	Clears the cache.
Parameters	None
Returns	None

getFlashDrivePath

Signature	plugins.core.loupedeckctandlive.manager:getFlashDrivePath() -> string
Type	Method
Description	Gets the Loupedeck Flash Drive path.
Parameters	None
Returns	The Loupedeck Flash Drive path as a string

refresh

Signature	plugins.core.loupedeckctandlive.manager:refresh()
Type	Method
Description	Refreshes the Loupedeck screens and LED buttons.
Parameters	dueToAppChange - A optional boolean to specify whether the refresh is due to an application focus change.
Returns	None

refreshItems

Signature	plugins.core.loupedeckctandlive.manager:refreshItems() -> self
Type	Method
Description	Refreshes the items to either either local drive or the Loupedeck Flash Drive.
Parameters	None
Returns	Self

reset

Signature	plugins.core.loupedeckctandlive.manager:reset()
Type	Method
Description	Resets the config back to the default layout.
Parameters	None
Returns	None