plugins.core.midi.manager.md

docs » 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
• numberOfMidiDevices

API Documentation

Variables

defaultLayout

Signature	plugins.core.midi.manager.defaultLayout -> table
Type	Variable
Description	Default MIDI Layout

defaultLoupedeckLayout

Signature	plugins.core.midi.manager.defaultLoupedeckLayout -> table
Type	Variable
Description	Default Loupedeck Layout

defaultLoupedeckPlusLayout

Signature	plugins.core.midi.manager.defaultLoupedeckPlusLayout -> table
Type	Variable
Description	Default Loupedeck+ Layout

lastActiveBundleID

Signature	plugins.core.midi.manager.lastActiveBundleID -> string
Type	Variable
Description	The last Active Bundle ID. Used for AudioSwift workaround.

learningMode

Signature	plugins.core.midi.manager.learningMode -> boolean
Type	Variable
Description	Whether or not the MIDI Manager is in learning mode.

maxItems

Signature	plugins.core.midi.manager.maxItems -> number
Type	Variable
Description	The maximum number of MIDI items per bank.

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.

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.

|

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

start

Signature	plugins.core.midi.manager.start() -> boolean
Type	Function
Description	Starts the MIDI Plugin
Parameters	None
Returns	None

stop

Signature	plugins.core.midi.manager.stop() -> boolean
Type	Function
Description	Stops the MIDI Plugin
Parameters	None
Returns	None

update

Signature	plugins.core.midi.manager.update() -> none
Type	Function
Description	Updates the MIDI Watchers.
Parameters	None
Returns	None

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.

Fields

activeBanks

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

activeLoupedeckBanks

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

activeLoupedeckPlusBanks

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

displayMessageWhenChangingBanks

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

enabled

Signature	plugins.core.midi.manager.enabled <cp.prop: boolean>
Type	Field
Description	Enable or disable MIDI Support.

enabledLoupedeck

Signature	plugins.core.midi.manager.enabledLoupedeck <cp.prop: boolean>
Type	Field
Description	Enable or disable MIDI Loupedeck Support.

enabledLoupedeckPlus

Signature	plugins.core.midi.manager.enabledLoupedeckPlus <cp.prop: boolean>
Type	Field
Description	Enable or disable MIDI Loupedeck+ Support.

numberOfMidiDevices

Signature	plugins.core.midi.manager.numberOfMidiDevices -> <cp.prop: number>
Type	Field
Description	Total number of MIDI Devices detected (including both physical and virtual).