# plugins.core.midi.manager
MIDI Manager Plugin.
---
## Submodules
* [plugins.core.midi.manager.controls](plugins.core.midi.manager.controls.md)
---
## API Overview
**Variables** - _Configurable values_
* [defaultLayout](#defaultlayout)
* [defaultLoupedeckLayout](#defaultloupedecklayout)
* [defaultLoupedeckPlusLayout](#defaultloupedeckpluslayout)
* [lastActiveBundleID](#lastactivebundleid)
* [learningMode](#learningmode)
* [maxItems](#maxitems)
**Functions** - _API calls offered directly by the extension_
* [devices](#devices)
* [getDevice](#getdevice)
* [getItem](#getitem)
* [start](#start)
* [stop](#stop)
* [update](#update)
* [virtualDevices](#virtualdevices)
**Fields** - _Variables which can only be accessed from an object returned by a constructor_
* [activeBanks](#activebanks)
* [activeLoupedeckBanks](#activeloupedeckbanks)
* [activeLoupedeckPlusBanks](#activeloupedeckplusbanks)
* [displayMessageWhenChangingBanks](#displaymessagewhenchangingbanks)
* [enabled](#enabled)
* [enabledLoupedeck](#enabledloupedeck)
* [enabledLoupedeckPlus](#enabledloupedeckplus)
* [ignoreEverySecondControlDialCommand](#ignoreeverysecondcontroldialcommand)
* [ignoreEverySecondP1ToP8WheelCommand](#ignoreeverysecondp1top8wheelcommand)
* [numberOfMidiDevices](#numberofmididevices)
---
## API Documentation
#### Variables
### [defaultLayout](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/midi/manager/init.lua#L67) |
---
### [defaultLoupedeckLayout](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/midi/manager/init.lua#L72) |
---
### [defaultLoupedeckPlusLayout](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/midi/manager/init.lua#L77) |
---
### [lastActiveBundleID](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/midi/manager/init.lua#L87) |
---
### [learningMode](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/midi/manager/init.lua#L82) |
---
### [maxItems](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/midi/manager/init.lua#L32) |
---
#### Functions
### [devices](#devices)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.midi.manager.devices() -> table` |
| **Type** | Function |
| **Description** | Gets a table of Physical MIDI Device Names. |
| **Parameters** | |
| **Returns** | - A table of Physical MIDI Device Names.
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/core/midi/manager/init.lua line 751](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/midi/manager/init.lua#L751) |
---
### [getDevice](#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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/midi/manager/init.lua#L777) |
---
### [getItem](#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** | |
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/core/midi/manager/init.lua line 506](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/midi/manager/init.lua#L506) |
---
### [start](#start)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.midi.manager.start() -> boolean` |
| **Type** | Function |
| **Description** | Starts the MIDI Plugin |
| **Parameters** | |
| **Returns** | |
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/core/midi/manager/init.lua line 794](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/midi/manager/init.lua#L794) |
---
### [stop](#stop)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.midi.manager.stop() -> boolean` |
| **Type** | Function |
| **Description** | Stops the MIDI Plugin |
| **Parameters** | |
| **Returns** | |
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/core/midi/manager/init.lua line 879](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/midi/manager/init.lua#L879) |
---
### [update](#update)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.midi.manager.update() -> none` |
| **Type** | Function |
| **Description** | Updates the MIDI Watchers. |
| **Parameters** | |
| **Returns** | |
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/core/midi/manager/init.lua line 898](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/midi/manager/init.lua#L898) |
---
### [virtualDevices](#virtualdevices)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.midi.manager.virtualDevices() -> table` |
| **Type** | Function |
| **Description** | Gets a table of Virtual MIDI Source Names. |
| **Parameters** | |
| **Returns** | - A table of Virtual MIDI Source Names.
|
| **Notes** | None |
| **Examples** | None |
| **Source** | [src/plugins/core/midi/manager/init.lua line 764](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/midi/manager/init.lua#L764) |
---
#### Fields
### [activeBanks](#activebanks)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.midi.manager.activeBanks ` |
| **Type** | Field |
| **Description** | Table of active banks for each application. |
| **Notes** | None |
| **Source** | [src/plugins/core/midi/manager/init.lua line 42](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/midi/manager/init.lua#L42) |
---
### [activeLoupedeckBanks](#activeloupedeckbanks)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.midi.manager.activeLoupedeckBanks ` |
| **Type** | Field |
| **Description** | Table of active banks for each application. |
| **Notes** | None |
| **Source** | [src/plugins/core/midi/manager/init.lua line 47](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/midi/manager/init.lua#L47) |
---
### [activeLoupedeckPlusBanks](#activeloupedeckplusbanks)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.midi.manager.activeLoupedeckPlusBanks ` |
| **Type** | Field |
| **Description** | Table of active banks for each application. |
| **Notes** | None |
| **Source** | [src/plugins/core/midi/manager/init.lua line 52](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/midi/manager/init.lua#L52) |
---
### [displayMessageWhenChangingBanks](#displaymessagewhenchangingbanks)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.midi.manager.displayMessageWhenChangingBanks ` |
| **Type** | Field |
| **Description** | Display message when changing banks? |
| **Notes** | None |
| **Source** | [src/plugins/core/midi/manager/init.lua line 37](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/midi/manager/init.lua#L37) |
---
### [enabled](#enabled)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.midi.manager.enabled ` |
| **Type** | Field |
| **Description** | Enable or disable MIDI Support. |
| **Notes** | None |
| **Source** | [src/plugins/core/midi/manager/init.lua line 920](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/midi/manager/init.lua#L920) |
---
### [enabledLoupedeck](#enabledloupedeck)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.midi.manager.enabledLoupedeck ` |
| **Type** | Field |
| **Description** | Enable or disable MIDI Loupedeck Support. |
| **Notes** | None |
| **Source** | [src/plugins/core/midi/manager/init.lua line 925](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/midi/manager/init.lua#L925) |
---
### [enabledLoupedeckPlus](#enabledloupedeckplus)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.midi.manager.enabledLoupedeckPlus ` |
| **Type** | Field |
| **Description** | Enable or disable MIDI Loupedeck+ Support. |
| **Notes** | None |
| **Source** | [src/plugins/core/midi/manager/init.lua line 930](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/midi/manager/init.lua#L930) |
---
### [ignoreEverySecondControlDialCommand](#ignoreeverysecondcontroldialcommand)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.midi.manager.ignoreEverySecondControlDialCommand ` |
| **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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/midi/manager/init.lua#L62) |
---
### [ignoreEverySecondP1ToP8WheelCommand](#ignoreeverysecondp1top8wheelcommand)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.midi.manager.ignoreEverySecondP1ToP8WheelCommand ` |
| **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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/midi/manager/init.lua#L57) |
---
### [numberOfMidiDevices](#numberofmididevices)
| | |
| --------------------------------------------|-------------------------------------------------------------------------------------|
| **Signature** | `plugins.core.midi.manager.numberOfMidiDevices -> ` |
| **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](https://github.com/CommandPost/CommandPost/blob/develop/src/plugins/core/midi/manager/init.lua#L915) |
---
---