plugins.core.midi.manager.md

docs » plugins.core.midi.manager

---

MIDI Manager Plugin.

Submodules

• plugins.core.midi.manager.controls

API Overview

• Variables - Configurable values
• defaultGroup
• maxItems
• Functions - API calls offered directly by the extension
• activeGroup
• clear
• devices
• getIcon
• groupStatus
• init
• midiCallback
• setItem
• start
• update
• updateAction
• virtualDevices
• Fields - Variables which can only be accessed from an object returned by a constructor
• buttons
• enabled

API Documentation

Variables

defaultGroup

Signature	plugins.core.midi.manager.defaultGroup -> string
Type	Variable
Description	The default group.

maxItems

Signature	plugins.core.midi.manager.maxItems -> number
Type	Variable
Description	The maximum number of Touch Bar items per group.

Functions

activeGroup

Signature	plugins.core.midi.manager.activeGroup() -> none
Type	Function
Description	Returns the active group.
Parameters	None
Returns	Returns the active group or manager.defaultGroup as a string.

clear

Signature	plugins.core.midi.manager.clear() -> none
Type	Function
Description	Clears the Touch Bar items.
Parameters	None
Returns	None

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.

getIcon

Signature	plugins.core.midi.manager.getIcon(button, group) -> string
Type	Function
Description	Returns a specific Touch Bar Icon.
Parameters	item - The item you want to get. button - Button ID as string group - Group ID as string
Returns	Icon data as string

groupStatus

Signature	plugins.core.midi.manager.groupStatus(groupID, status) -> none
Type	Function
Description	Updates a group's visibility status.
Parameters	groupID - the group you want to update as a string. status - the status of the group as a boolean.
Returns	None

init

Signature	plugins.core.midi.manager.init(deps, env) -> none
Type	Function
Description	Initialises the MIDI Plugin
Parameters	deps - Dependencies Table env - Environment Table
Returns	None

midiCallback

Signature	plugins.core.midi.manager.midiCallback(object, deviceName, commandType, description, metadata) -> none
Type	Function
Description	MIDI Callback
Parameters	object - The hs.midi userdata object deviceName - Device name as string commandType - Command Type as string description - Description as string metadata - A table containing metadata for the MIDI command
Returns	None

setItem

Signature	plugins.core.midi.manager.setItem(item, button, group, value) -> none
Type	Function
Description	Stores a MIDI value in Preferences.
Parameters	item - The item you want to set. button - Button ID as string group - Group ID as string value - The value of the item you want to set.
Returns	None

start

Signature	plugins.core.midi.manager.start() -> 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

updateAction

Signature	plugins.core.midi.manager.updateAction(button, group, action) -> none
Type	Function
Description	Updates a Touch Bar action.
Parameters	button - Button ID as string group - Group ID as string action - Action as string
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

buttons

Signature	plugins.core.midi.manager.buttons <cp.prop: table>
Type	Field
Description	Contains all the saved Touch Bar Buttons

enabled

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