#plugins.core.midi.manager

MIDI Manager Plugin.

#Submodules

#API Overview

Variables - Configurable values

Functions - API calls offered directly by the extension

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

#API Documentation

#Variables

Signatureplugins.core.midi.manager.defaultLayout -> table
TypeVariable
DescriptionDefault MIDI Layout
NotesNone
Sourcesrc/plugins/core/midi/manager/init.lua line 67
Signatureplugins.core.midi.manager.defaultLoupedeckLayout -> table
TypeVariable
DescriptionDefault Loupedeck Layout
NotesNone
Sourcesrc/plugins/core/midi/manager/init.lua line 72
Signatureplugins.core.midi.manager.defaultLoupedeckPlusLayout -> table
TypeVariable
DescriptionDefault Loupedeck+ Layout
NotesNone
Sourcesrc/plugins/core/midi/manager/init.lua line 77
Signatureplugins.core.midi.manager.lastActiveBundleID -> string
TypeVariable
DescriptionThe last Active Bundle ID. Used for AudioSwift workaround.
NotesNone
Sourcesrc/plugins/core/midi/manager/init.lua line 87
Signatureplugins.core.midi.manager.learningMode -> boolean
TypeVariable
DescriptionWhether or not the MIDI Manager is in learning mode.
NotesNone
Sourcesrc/plugins/core/midi/manager/init.lua line 82
Signatureplugins.core.midi.manager.maxItems -> number
TypeVariable
DescriptionThe maximum number of MIDI items per bank.
NotesNone
Sourcesrc/plugins/core/midi/manager/init.lua line 32

#Functions

Signatureplugins.core.midi.manager.devices() -> table
TypeFunction
DescriptionGets a table of Physical MIDI Device Names.
Parameters
  • None
Returns
  • A table of Physical MIDI Device Names.
NotesNone
ExamplesNone
Sourcesrc/plugins/core/midi/manager/init.lua line 751
Signatureplugins.core.midi.manager.getDevice(deviceName, virtual) -> hs.midi object | nil
TypeFunction
DescriptionGets 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.
NotesNone
ExamplesNone
Sourcesrc/plugins/core/midi/manager/init.lua line 777
Signatureplugins.core.midi.manager.getItem(item, button, group) -> table
TypeFunction
DescriptionGets 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
NotesNone
ExamplesNone
Sourcesrc/plugins/core/midi/manager/init.lua line 506
Signatureplugins.core.midi.manager.start() -> boolean
TypeFunction
DescriptionStarts the MIDI Plugin
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/core/midi/manager/init.lua line 794
Signatureplugins.core.midi.manager.stop() -> boolean
TypeFunction
DescriptionStops the MIDI Plugin
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/core/midi/manager/init.lua line 879
Signatureplugins.core.midi.manager.update() -> none
TypeFunction
DescriptionUpdates the MIDI Watchers.
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/core/midi/manager/init.lua line 898
Signatureplugins.core.midi.manager.virtualDevices() -> table
TypeFunction
DescriptionGets a table of Virtual MIDI Source Names.
Parameters
  • None
Returns
  • A table of Virtual MIDI Source Names.
NotesNone
ExamplesNone
Sourcesrc/plugins/core/midi/manager/init.lua line 764

#Fields

Signatureplugins.core.midi.manager.activeBanks <cp.prop: table>
TypeField
DescriptionTable of active banks for each application.
NotesNone
Sourcesrc/plugins/core/midi/manager/init.lua line 42
Signatureplugins.core.midi.manager.activeLoupedeckBanks <cp.prop: table>
TypeField
DescriptionTable of active banks for each application.
NotesNone
Sourcesrc/plugins/core/midi/manager/init.lua line 47
Signatureplugins.core.midi.manager.activeLoupedeckPlusBanks <cp.prop: table>
TypeField
DescriptionTable of active banks for each application.
NotesNone
Sourcesrc/plugins/core/midi/manager/init.lua line 52
Signatureplugins.core.midi.manager.displayMessageWhenChangingBanks <cp.prop: boolean>
TypeField
DescriptionDisplay message when changing banks?
NotesNone
Sourcesrc/plugins/core/midi/manager/init.lua line 37
Signatureplugins.core.midi.manager.enabled <cp.prop: boolean>
TypeField
DescriptionEnable or disable MIDI Support.
NotesNone
Sourcesrc/plugins/core/midi/manager/init.lua line 920
Signatureplugins.core.midi.manager.enabledLoupedeck <cp.prop: boolean>
TypeField
DescriptionEnable or disable MIDI Loupedeck Support.
NotesNone
Sourcesrc/plugins/core/midi/manager/init.lua line 925
Signatureplugins.core.midi.manager.enabledLoupedeckPlus <cp.prop: boolean>
TypeField
DescriptionEnable or disable MIDI Loupedeck+ Support.
NotesNone
Sourcesrc/plugins/core/midi/manager/init.lua line 930
Signatureplugins.core.midi.manager.ignoreEverySecondControlDialCommand <cp.prop: boolean>
TypeField
DescriptionA preference for ignoring double actions when turning the Control Dial
NotesNone
Sourcesrc/plugins/core/midi/manager/init.lua line 62
Signatureplugins.core.midi.manager.ignoreEverySecondP1ToP8WheelCommand <cp.prop: boolean>
TypeField
DescriptionA preference for ignoring double actions when turning a P1 to P8 wheel.
NotesNone
Sourcesrc/plugins/core/midi/manager/init.lua line 57
Signatureplugins.core.midi.manager.numberOfMidiDevices -> <cp.prop: number>
TypeField
DescriptionTotal number of MIDI Devices detected (including both physical and virtual).
NotesNone
Sourcesrc/plugins/core/midi/manager/init.lua line 915

© Copyright 2024 LateNite Films Pty Ltd. All rights reserved.