plugins.core.controlsurfaces.manager.md

docs » plugins.core.controlsurfaces.manager

---

Manager for the CommandPost Preferences Window.

API Overview

• Constants - Useful values which cannot be changed
• DEFAULT_HEIGHT
• DEFAULT_WIDTH
• lastTab
• NUMBER_OF_BANKS
• NUMBER_OF_DEVICES
• position
• WEBVIEW_LABEL
• Variables - Configurable values
• _handlers
• _panels
• Functions - API calls offered directly by the extension
• addHandler
• addPanel
• currentPanelID
• focus
• getHandler
• getLabel
• getWebview
• hide
• init
• injectScript
• maxPanelHeight
• new
• refresh
• selectPanel
• setPanelRenderer
• show

API Documentation

Constants

DEFAULT_HEIGHT

Signature	plugins.core.controlsurfaces.manager.DEFAULT_HEIGHT -> number
Type	Constant
Description	Default Height of Preferences Window

DEFAULT_WIDTH

Signature	plugins.core.controlsurfaces.manager.DEFAULT_WIDTH -> number
Type	Constant
Description	Default Width of Preferences Window

lastTab

Signature	plugins.core.controlsurfaces.manager.lastTab
Type	Constant
Description	Returns the last tab saved in settings.

NUMBER_OF_BANKS

Signature	plugins.core.controlsurfaces.manager.NUMBER_OF_BANKS -> number
Type	Constant
Description	Number of banks.

NUMBER_OF_DEVICES

Signature	plugins.core.controlsurfaces.manager.NUMBER_OF_DEVICES -> number
Type	Constant
Description	Number of devices.

position

Signature	plugins.core.controlsurfaces.manager.position
Type	Constant
Description	Returns the last frame saved in settings.

WEBVIEW_LABEL

Signature	plugins.core.controlsurfaces.manager.WEBVIEW_LABEL -> string
Type	Constant
Description	The WebView Label

Variables

_handlers

Signature	plugins.core.controlsurfaces.manager._handlers -> table
Type	Variable
Description	Table containing handlers.

_panels

Signature	plugins.core.controlsurfaces.manager._panels -> table
Type	Variable
Description	Table containing panels.

Functions

addHandler

Signature	plugins.core.controlsurfaces.manager.addHandler(id, handlerFn) -> string
Type	Function
Description	Adds a Handler
Parameters	id - The ID handlerFn - the handler function
Returns	Nothing

addPanel

Signature	plugins.core.controlsurfaces.manager.addPanel(params) -> plugins.core.controlsurfaces.manager.panel
Type	Function
Description	Adds a new panel with the specified params to the preferences manager.
Parameters	params - The parameters table. Details below.
Returns	The new panel instance.
Notes	The params can have the following properties. The priority and id and properties are required. priority - An integer value specifying the priority of the panel compared to others. id - A string containing the unique ID of the panel. label - The human-readable label for the panel icon. image - The hs.image for the panel icon. tooltip - The human-readable details for the toolbar icon when the mouse is hovering over it. closeFn - A callback function that's triggered when the Preferences window is closed.

currentPanelID

Signature	plugins.core.controlsurfaces.manager.currentPanelID() -> string
Type	Function
Description	Returns the panel ID with the highest priority.
Parameters	None
Returns	The panel ID as a string

focus

Signature	plugins.core.controlsurfaces.manager.focus() -> boolean
Type	Function
Description	Puts focus on the Preferences Window.
Parameters	None
Returns	true if successful or otherwise false.

getHandler

Signature	plugins.core.controlsurfaces.manager.getHandler(id) -> string
Type	Function
Description	Returns the handler for a given ID.
Parameters	id - The ID
Returns	Table

getLabel

Signature	plugins.core.controlsurfaces.manager.getLabel() -> string
Type	Function
Description	Returns the Webview label.
Parameters	None
Returns	The Webview label as a string.

getWebview

Signature	plugins.core.controlsurfaces.manager.getWebview() -> hs.webview
Type	Function
Description	Returns the Webview of the Preferences Window.
Parameters	None
Returns	A hs.webview

hide

Signature	plugins.core.controlsurfaces.manager.hide() -> none
Type	Function
Description	Hides the Preferences Window.
Parameters	None
Returns	None

init

Signature	plugins.core.controlsurfaces.manager.init() -> nothing
Type	Function
Description	Initialises the preferences panel.
Parameters	None
Returns	Nothing

injectScript

Signature	plugins.core.controlsurfaces.manager.injectScript(script) -> none
Type	Function
Description	Injects JavaScript into the Preferences Webview.
Parameters	script - The JavaScript code you want to inject in the form of a string.
Returns	None

maxPanelHeight

Signature	plugins.core.controlsurfaces.manager.maxPanelHeight() -> number
Type	Function
Description	Returns the maximum size defined by a panel.
Parameters	None
Returns	The maximum panel height.

new

Signature	plugins.core.controlsurfaces.manager.new() -> none
Type	Function
Description	Creates a new Preferences Window.
Parameters	None
Returns	None

refresh

Signature	plugins.core.controlsurfaces.manager.refresh() -> none
Type	Function
Description	Refreshes the Preferences Window.
Parameters	None
Returns	None

selectPanel

Signature	plugins.core.controlsurfaces.manager.selectPanel(id) -> none
Type	Function
Description	Selects a Preferences Panel.
Parameters	id - the ID of the panel you want to select.
Returns	None

setPanelRenderer

Signature	plugins.core.controlsurfaces.manager.setPanelRenderer(renderer) -> none
Type	Function
Description	Sets a Panel Renderer
Parameters	renderer - The renderer
Returns	None

show

Signature	plugins.core.controlsurfaces.manager.show() -> boolean
Type	Function
Description	Shows the Preferences Window
Parameters	None
Returns	True if successful or nil if an error occurred