plugins.core.tourbox.manager.md

docs » plugins.core.tourbox.manager

---

Loupedeck CT Manager Plugin.

API Overview

• Variables - Configurable values
• defaultLayout
• Functions - API calls offered directly by the extension
• connectToTourBox
• reset
• resetTimers
• Fields - Variables which can only be accessed from an object returned by a constructor
• activeBanks
• automaticallySwitchApplications
• displayMessageWhenChangingBanks
• enabled
• items

API Documentation

Variables

defaultLayout

Signature	plugins.core.tourbox.manager.defaultLayout -> table
Type	Variable
Description	Default Loupedeck CT Layout

Functions

connectToTourBox

Signature	plugins.core.tourbox.manager.connectToTourBox() -> none
Type	Function
Description	Attempts to establish the TourBox serial connection.
Parameters	None
Returns	None

reset

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

resetTimers

Signature	plugins.core.tourbox.manager.resetTimers() -> none
Type	Function
Description	Resets all the various timers and memories.
Parameters	None
Returns	None

Fields

activeBanks

Signature	plugins.core.tourbox.manager.activeBanks <cp.prop: table>
Type	Field
Description	Table of active banks for each application.

automaticallySwitchApplications

Signature	plugins.core.tourbox.manager.automaticallySwitchApplications <cp.prop: boolean>
Type	Field
Description	Enable or disable the automatic switching of applications.

displayMessageWhenChangingBanks

Signature	plugins.core.tourbox.manager.displayMessageWhenChangingBanks <cp.prop: boolean>
Type	Field
Description	Display message when changing banks?

enabled

Signature	plugins.core.tourbox.manager.enabled <cp.prop: boolean>
Type	Field
Description	Is Loupedeck CT support enabled?

items

Signature	plugins.core.tourbox.manager.items <cp.prop: table>
Type	Field
Description	Contains all the saved TourBox layouts.