# 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
Notes None
Source src/plugins/core/tourbox/manager/init.lua line 540

# Functions

# connectToTourBox

Signature plugins.core.tourbox.manager.connectToTourBox([portName]) -> none
Type Function
Description Attempts to establish the TourBox serial connection.
Parameters
  • portName - The optional port name of the device.
Returns
  • None
Notes None
Examples None
Source src/plugins/core/tourbox/manager/init.lua line 411

# reset

Signature plugins.core.tourbox.manager.reset()
Type Function
Description Resets the config back to the default layout.
Parameters
  • None
Returns
  • None
Notes None
Examples None
Source src/plugins/core/tourbox/manager/init.lua line 570

# resetTimers

Signature plugins.core.tourbox.manager.resetTimers() -> none
Type Function
Description Resets all the various timers and memories.
Parameters
  • None
Returns
  • None
Notes None
Examples None
Source src/plugins/core/tourbox/manager/init.lua line 473

# Fields

# activeBanks

Signature plugins.core.tourbox.manager.activeBanks <cp.prop: table>
Type Field
Description Table of active banks for each application.
Notes None
Source src/plugins/core/tourbox/manager/init.lua line 565

# automaticallySwitchApplications

Signature plugins.core.tourbox.manager.automaticallySwitchApplications <cp.prop: boolean>
Type Field
Description Enable or disable the automatic switching of applications.
Notes None
Source src/plugins/core/tourbox/manager/init.lua line 555

# displayMessageWhenChangingBanks

Signature plugins.core.tourbox.manager.displayMessageWhenChangingBanks <cp.prop: boolean>
Type Field
Description Display message when changing banks?
Notes None
Source src/plugins/core/tourbox/manager/init.lua line 550

# enabled

Signature plugins.core.tourbox.manager.enabled <cp.prop: boolean>
Type Field
Description Is Loupedeck CT support enabled?
Notes None
Source src/plugins/core/tourbox/manager/init.lua line 498

# items

Signature plugins.core.tourbox.manager.items <cp.prop: table>
Type Field
Description Contains all the saved TourBox layouts.
Notes None
Source src/plugins/core/tourbox/manager/init.lua line 560