# plugins.core.midi.manager

MIDI Manager Plugin.

# Submodules

plugins.core.midi.manager.controls

# API Overview

Variables - Configurable values

defaultLayout
defaultLoupedeckLayout
defaultLoupedeckPlusLayout
lastActiveBundleID
learningMode
maxItems

Functions - API calls offered directly by the extension

devices
getDevice
getItem
start
stop
update
virtualDevices

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

activeBanks
activeLoupedeckBanks
activeLoupedeckPlusBanks
displayMessageWhenChangingBanks
enabled
enabledLoupedeck
enabledLoupedeckPlus
ignoreEverySecondControlDialCommand
ignoreEverySecondP1ToP8WheelCommand
numberOfMidiDevices

# API Documentation

# Variables

# defaultLayout


Signature	`plugins.core.midi.manager.defaultLayout -> table`
Type	Variable
Description	Default MIDI Layout
Notes	None
Source	src/plugins/core/midi/manager/init.lua line 67

# defaultLoupedeckLayout


Signature	`plugins.core.midi.manager.defaultLoupedeckLayout -> table`
Type	Variable
Description	Default Loupedeck Layout
Notes	None
Source	src/plugins/core/midi/manager/init.lua line 72

# defaultLoupedeckPlusLayout


Signature	`plugins.core.midi.manager.defaultLoupedeckPlusLayout -> table`
Type	Variable
Description	Default Loupedeck+ Layout
Notes	None
Source	src/plugins/core/midi/manager/init.lua line 77

# lastActiveBundleID


Signature	`plugins.core.midi.manager.lastActiveBundleID -> string`
Type	Variable
Description	The last Active Bundle ID. Used for AudioSwift workaround.
Notes	None
Source	src/plugins/core/midi/manager/init.lua line 87

# learningMode


Signature	`plugins.core.midi.manager.learningMode -> boolean`
Type	Variable
Description	Whether or not the MIDI Manager is in learning mode.
Notes	None
Source	src/plugins/core/midi/manager/init.lua line 82

# maxItems


Signature	`plugins.core.midi.manager.maxItems -> number`
Type	Variable
Description	The maximum number of MIDI items per bank.
Notes	None
Source	src/plugins/core/midi/manager/init.lua line 32

# Functions

# devices


Signature	`plugins.core.midi.manager.devices() -> table`
Type	Function
Description	Gets a table of Physical MIDI Device Names.
Parameters	None
Returns	A table of Physical MIDI Device Names.
Notes	None
Examples	None
Source	src/plugins/core/midi/manager/init.lua line 751

# getDevice


Signature	`plugins.core.midi.manager.getDevice(deviceName, virtual) -> hs.midi object \| nil`
Type	Function
Description	Gets a MIDI Device.
Parameters	deviceName - The device name. virtual - A boolean that defines whether or not the device is virtual.
Returns	A `hs.midi` object or nil if no MIDI device by that name exists.
Notes	None
Examples	None
Source	src/plugins/core/midi/manager/init.lua line 777

# getItem


Signature	`plugins.core.midi.manager.getItem(item, button, group) -> table`
Type	Function
Description	Gets a MIDI item from Preferences.
Parameters	item - The item you want to get. button - Button ID as string group - Group ID as string
Returns	A table otherwise `nil`
Notes	None
Examples	None
Source	src/plugins/core/midi/manager/init.lua line 506

# start


Signature	`plugins.core.midi.manager.start() -> boolean`
Type	Function
Description	Starts the MIDI Plugin
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/core/midi/manager/init.lua line 794

# stop


Signature	`plugins.core.midi.manager.stop() -> boolean`
Type	Function
Description	Stops the MIDI Plugin
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/core/midi/manager/init.lua line 879

# update


Signature	`plugins.core.midi.manager.update() -> none`
Type	Function
Description	Updates the MIDI Watchers.
Parameters	None
Returns	None
Notes	None
Examples	None
Source	src/plugins/core/midi/manager/init.lua line 898

# virtualDevices


Signature	`plugins.core.midi.manager.virtualDevices() -> table`
Type	Function
Description	Gets a table of Virtual MIDI Source Names.
Parameters	None
Returns	A table of Virtual MIDI Source Names.
Notes	None
Examples	None
Source	src/plugins/core/midi/manager/init.lua line 764

# Fields

# activeBanks


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

# activeLoupedeckBanks


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

# activeLoupedeckPlusBanks


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

# displayMessageWhenChangingBanks


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

# enabled


Signature	`plugins.core.midi.manager.enabled <cp.prop: boolean>`
Type	Field
Description	Enable or disable MIDI Support.
Notes	None
Source	src/plugins/core/midi/manager/init.lua line 920

# enabledLoupedeck


Signature	`plugins.core.midi.manager.enabledLoupedeck <cp.prop: boolean>`
Type	Field
Description	Enable or disable MIDI Loupedeck Support.
Notes	None
Source	src/plugins/core/midi/manager/init.lua line 925

# enabledLoupedeckPlus


Signature	`plugins.core.midi.manager.enabledLoupedeckPlus <cp.prop: boolean>`
Type	Field
Description	Enable or disable MIDI Loupedeck+ Support.
Notes	None
Source	src/plugins/core/midi/manager/init.lua line 930

# ignoreEverySecondControlDialCommand


Signature	`plugins.core.midi.manager.ignoreEverySecondControlDialCommand <cp.prop: boolean>`
Type	Field
Description	A preference for ignoring double actions when turning the Control Dial
Notes	None
Source	src/plugins/core/midi/manager/init.lua line 62

# ignoreEverySecondP1ToP8WheelCommand


Signature	`plugins.core.midi.manager.ignoreEverySecondP1ToP8WheelCommand <cp.prop: boolean>`
Type	Field
Description	A preference for ignoring double actions when turning a P1 to P8 wheel.
Notes	None
Source	src/plugins/core/midi/manager/init.lua line 57

# numberOfMidiDevices


Signature	`plugins.core.midi.manager.numberOfMidiDevices -> <cp.prop: number>`
Type	Field
Description	Total number of MIDI Devices detected (including both physical and virtual).
Notes	None
Source	src/plugins/core/midi/manager/init.lua line 915