plugins.core.monogram.manager

Monogram Manager Plugin.

---

API Overview

Constants - Useful values which cannot be changed

• NUMBER_OF_FAVOURITES

Variables - Configurable values

• favourites
• lastPort
• performAction
• plugins

Functions - API calls offered directly by the extension

• changeContext
• launchCreatorBundle
• registerAction
• registerPlugin
• setEnabled
• sign

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

• automaticProfileSwitching
• enabled

---

API Documentation

Constants

NUMBER_OF_FAVOURITES

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

---

Variables

favourites

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

---

lastPort

Signature	plugins.core.monogram.manager.lastPort -> number
Type	Variable
Description	The port that Monogram Creator used to connect to CommandPost.
Notes	None
Source	src/plugins/core/monogram/manager/init.lua line 57

---

performAction

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

---

plugins

Signature	plugins.core.monogram.manager.plugins -> table
Type	Variable
Description	A table of Monogram plugins to install.
Notes	None
Source	src/plugins/core/monogram/manager/init.lua line 98

---

Functions

changeContext

Signature	plugins.core.monogram.manager.changeContext(context) -> none
Type	Function
Description	Switches the Monogram Profile.
Parameters	context - The name of the context you want to switch to.
Returns	None
Notes	None
Examples	None
Source	src/plugins/core/monogram/manager/init.lua line 283

---

launchCreatorBundle

Signature	plugins.core.monogram.manager.launchCreatorBundle() -> none
Type	Function
Description	Launch the Monogram Creator.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/core/monogram/manager/init.lua line 175

---

registerAction

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

---

registerPlugin

Signature	plugins.core.monogram.manager.registerPlugin(name, path) -> none
Type	Function
Description	Registers a new Monogram plugin.
Parameters	name - The name of the plugin. path - The path to the folder containing the plugin.
Returns	None
Notes	None
Examples	None
Source	src/plugins/core/monogram/manager/init.lua line 103

---

setEnabled

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

---

sign

Signature	plugins.core.monogram.manager.sign() -> none
Type	Function
Description	Signs all the Monogram Integrations.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/core/monogram/manager/init.lua line 305

---

Fields

automaticProfileSwitching

Signature	plugins.core.monogram.manager.automaticProfileSwitching <cp.prop: boolean>
Type	Field
Description	Enable or disable Automatic Profile Switching
Notes	None
Source	src/plugins/core/monogram/manager/init.lua line 258

---

enabled

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

---

---