plugins.core.loupedeckplugin.manager

Loupedeck Plugin Manager Plugin.

---

API Overview

Constants - Useful values which cannot be changed

• NUMBER_OF_FAVOURITES

Variables - Configurable values

• favourites
• performAction

Functions - API calls offered directly by the extension

• installPlugin
• registerAction
• removePlugin
• requestKeywordShortcuts
• sendMessage
• setEnabled
• startWebSocketClient
• stopWebSocketClient
• updatePlugin

Fields - Variables which can only be accessed from an object returned by a constructor

• enabled

---

API Documentation

Constants

NUMBER_OF_FAVOURITES

Signature	plugins.core.loupedeckplugin.manager.NUMBER_OF_FAVOURITES -> number
Type	Constant
Description	Number of favourites
Notes	None
Source	src/plugins/core/loupedeckplugin/manager/init.lua line 38

---

Variables

favourites

Signature	plugins.core.loupedeckplugin.manager.favourites <cp.prop: table>
Type	Variable
Description	A cp.prop that that contains all the Monogram Favourites.
Notes	None
Source	src/plugins/core/loupedeckplugin/manager/init.lua line 63

---

performAction

Signature	plugins.core.loupedeckplugin.manager.performAction -> table
Type	Variable
Description	A table of actions that are triggered by the callback function.
Notes	None
Source	src/plugins/core/loupedeckplugin/manager/init.lua line 68

---

Functions

installPlugin

Signature	plugins.core.loupedeckplugin.manager.installPlugin() -> boolean
Type	Function
Description	Installs the Loupedeck Plugin.
Parameters	None
Returns	true if successful otherwise false if fails.
Notes	None
Examples	None
Source	src/plugins/core/loupedeckplugin/manager/init.lua line 199

---

registerAction

Signature	plugins.core.loupedeckplugin.manager.registerAction(name, fn) -> none
Type	Function
Description	Registers a new Loupedeck Plugin Action.
Parameters	name - The name of the action. fn - The function to trigger.
Returns	None
Notes	None
Examples	None
Source	src/plugins/core/loupedeckplugin/manager/init.lua line 73

---

removePlugin

Signature	plugins.core.loupedeckplugin.manager.removePlugin() -> boolean
Type	Function
Description	Removes the Loupedeck Plugin.
Parameters	None
Returns	Will always return true.
Notes	None
Examples	None
Source	src/plugins/core/loupedeckplugin/manager/init.lua line 379

---

requestKeywordShortcuts

Signature	plugins.core.loupedeckplugin.manager.requestKeywordShortcuts(data) -> none
Type	Function
Description	Triggered when the Loupedeck Service requests a JSON of commands
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/finalcutpro/loupedeckplugin/init.lua line 942

---

sendMessage

Signature	plugins.core.loupedeckplugin.manager.sendMessage(message) -> none
Type	Function
Description	Sends a websocket message.
Parameters	message - The message to send
Returns	None
Notes	None
Examples	None
Source	src/plugins/core/loupedeckplugin/manager/init.lua line 134

---

setEnabled

Signature	plugins.core.loupedeckplugin.manager.setEnabled(enabled) -> none
Type	Function
Description	Enables or disables Loupedeck Plugin Support.
Parameters	enabled - A boolean
Returns	true if Loupedeck Plugin support is enabled, otherwise false
Notes	None
Examples	None
Source	src/plugins/core/loupedeckplugin/manager/init.lua line 405

---

startWebSocketClient

Signature	plugins.core.loupedeckplugin.manager.startWebSocketClient() -> none
Type	Function
Description	Starts the WebSocket Client.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/core/loupedeckplugin/manager/init.lua line 149

---

stopWebSocketClient

Signature	plugins.core.loupedeckplugin.manager.stopWebSocketClient() -> none
Type	Function
Description	Stops the WebSocket Client.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/core/loupedeckplugin/manager/init.lua line 173

---

updatePlugin

Signature	plugins.core.loupedeckplugin.manager.updatePlugin() -> none
Type	Function
Description	Updates the Loupedeck Plugin.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/core/loupedeckplugin/manager/init.lua line 293

---

Fields

enabled

Signature	plugins.core.loupedeckplugin.manager.enabled <cp.prop: boolean>
Type	Field
Description	Enable or disable Monogram Support.
Notes	None
Source	src/plugins/core/loupedeckplugin/manager/init.lua line 188

---

---